Contents x
    Webhook request
    • 08 Sep 2025
    • 1 Minute to read
    • PDF
    Contents

    Webhook request

    • Updated on 08 Sep 2025
    • 1 Minute to read
    • PDF
    Article summary

    The webhook request will consist of data in both the HTTP header & body sections.

    Webhook Headers

    The HTTP headers are used for authentication of the message data.

    Name

    Purpose

    webhook-id

    This is the webhook message id.

    This can be used to ensure a message is only processed once.

    webhook-timestamp

    This is the timestamp that the message was sent.

    This can used to ensure older messages are ignored.

    webhook-signature

    This is the signature of the webhook message.
    This can be used to verify that the data has been sent from carehome.co.uk

    Webhook Message

    The message data (HTTP body) is a JSON object representing the event. The event JSON object data has 3 properties; type, timestamp and data. The data property is a JSON object will always have an id property, the other properties will depend on the type of event.

    {"type":"brochure.created","timestamp":"2025-04-01T10:26:10.344522Z","data":{"id":"123456"}}

    Verify the Webhook Signature

    To verify the signature create a text string of 3 parts; webhook-id, webhook-timestamp and the HTTP body(JSON object string), separate the 3 parts with a ’.’, see below for example.  Has the string with your secret key & the HMACSHA256 algorithm to match this signature.

    msg_2KWPBgLlAfxdpx2AI54pPJ85f4W.1674087231.{"type":"brochure.created","timestamp":"2025-04-01T10:26:10.344522Z","data":{"id":"123456"}}

    Was this article helpful?
    What's Next