Contents x
    Webhook request
    • 09 Jun 2025
    • 1 Minute to read
    • PDF
    Contents

    Webhook request

    • Updated on 09 Jun 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.

    You can also check this against the message id in the HTTP body.

    webhook-timestamp

    This is the timestamp that the message was sent.

    This can used to ensure older messages are ignored.

    You can also check this against the message timestamp in the HTTP body.

    webhook-signature

    This is the signature of the webhook message.

    You should hash the HTTP body with your secret key & the SHA256 algorithm to match this signature.

    Webhook Message

    The message data (HTTP body) is a text string of 3 parts; message id, timestamp and the event JSON data object. The string is separated by ‘.’, for example

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

    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"
        ...
    }
}

    Was this article helpful?
    What's Next