The WebhookHistory JSON object is the history of the JSON structure sent as the body of the post made to Webhook callback URLs.

Please reference the Webhook Overview to understand how the Webhook system works.

- Make sure you're familiar with JSON before continuing.
- The JSON objects are defined using Orderly.  Optional attrs end with a "?" all others are required.

- isodate fields use one of these ISO 8601 format: 2014-01-01T10:30:00.000+01:00, 2014-01-01T10:30:00.000+0100, 2014-01-01T10:30:00.000Z
- Dsco reserves the right to add new attributes at any time so Partners should ensure their validators won't break should this happen

Definition

Referenced Objects:

Object
{
    int webhookHistoryId;            # Unique ID for this webhook history record
    bool success;                    # If true, Dsco received a 200-level response
                                     # in the response when it sent the webhook event
    string callbackUrl;              # The URL we sent the webhook event to
    string hash;                     # The hash computed from the event webhook (payload.payload)
    ref WebhookEvent payload;        # The webhook event this history represents
    int httpStatusCode;              # The HTTP response code
                                     # https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
    string httpErrorMessage?;        # The HTTP client-provided error message if there is one
    string failureMessage?;          # If failed, an error message indicating why
    isodate createDate;              # The date the history record was created
};

Example

{
    "webhookHistoryId": 342342342,
    "success": true,
    "callbackUrl": "https://acme.com",
    "hash": "0676C0B637F683A39F1C578FAB3A43A4DC3D1",
    "payload": <WebhookEvent>,
    "httpStatusCode": 200,
    "httpErrorMessage": null,
    "failureMessage": null,
    "createDate": "2015-04-04T10:12:00+01:00",
}
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.