Read webhook delivery

GET 
/v2/config/webhooks/:webhookId/delivery/:deliveryId

This endpoint reads 1 payload delivery of a webhook. Give the webhook ID and the delivery ID in the path.

The service sends the delivery object as the whole response body. There is no wrapper field.

The service does not send the request headers, the request payload, the response headers or the response body of the delivery. It keeps them, but no endpoint gives them back.

Request

Path Parameters

webhookId stringrequired
deliveryId stringrequired

Responses

200

The service returned the webhook delivery.

Response Headers

application/json

Schema

Schema

id stringrequired

Unique identifier of the delivery. This is the deliveryID field of the delivered payload.

webhookId stringrequired

Unique identifier of the webhook that made the delivery.

responseStatusCode int32required

HTTP status code that the payload URL sent. The value is 0 when the service could not reach the payload URL.

responseStatusStr stringrequired

HTTP status text that the payload URL sent. The value is an empty string when the service could not reach the payload URL.

timestamp stringrequired

UTC time when the delivery started.

status stringrequired

Possible values: [completed, failed]

Result of the delivery. completed means the payload URL answered, also when it answered with an error code. Read responseStatusCode to see the answer. failed means the service could not reach the payload URL.

statusDescription stringrequired

Reason for a failure. The value is an empty string when the delivery succeeded.

Example (from schema)

{
  "id": "68a1f2c3d4e5f6a7b8c9d0e1",
  "webhookId": "string",
  "responseStatusCode": 200,
  "responseStatusStr": "200 OK",
  "timestamp": "string",
  "status": "completed",
  "statusDescription": "string"
}

400

The webhook has no delivery with the given delivery ID.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

404

The organisation has no webhook with the given webhook ID.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...