List all attempts and responses for webhook delivery

Retrieves the details of attempts and responses for webhook delivery

SecurityAuthToken
Request
query Parameters
attempted_at
string <date-time>

Filter items on the attempted_at timestamp. Must be in ISO-8601 format.

attempted_at.gt
string <date-time>

Filter items gt(>) attempted_at timestamp. Must be in ISO-8601 format.

attempted_at.gte
string <date-time>

Filter items gte(=>) attempted_at timestamp. Must be in ISO-8601 format.

attempted_at.lt
string <date-time>

Filter items lt(<) attempted_at timestamp. Must be in ISO-8601 format.

attempted_at.lte
string <date-time>

Filter items lte(<=) attempted_at timestamp. Must be in ISO-8601 format.

event_id
string

Filter items on the event_id, i.e. the unique ID of the event.

webhook_config_id
string

Filter items on the webhook_config_id, i.e. the unique ID of the webhook (i.e. webhook configuration).

webhook_config_url
string

Filter items on the webhook_config_url, i.e. the URL that is associated with the webhook delivery attempt or response.

response_code
integer

Filter items by the response code (e.g. HTTP response codes like 200, 404, 400, 202, 500, etc.). Pass the integer response code.

Example: response_code=200
response_code.in
Array of integers non-empty

A comma-separated list of up to 20 integer response codes. You may also pass null as a value to indicate no response code (i.e. attempt/response did not return a response code due to a timeout, etc.). You may pass either response_code or response_code.in, but not both.

Example: response_code.in=200,201,202,400,404,500
response_code.gt
integer

Filter items gt(>) response_code.

response_code.gte
integer

Filter items gte(=>) response_code.

response_code.lt
integer

Filter items lt(<) response_code.

response_code.lte
integer

Filter items lte(<=) response_code timestamp.

starting_after
string

The ID of the previous item to start the page after.

ending_before
string

The ID of the first item of the next page. This current page ends with the ID immediately preceding the one given in this parameter.

limit
integer [ 1 .. 50 ]
Default: 20

The numbers of items to return on this page.

Responses
200

List all attempts and responses for webhooks

Response Schema: application/json
Array of objects (WebhookAttempt)
get/webhooks/attempts/
Request samples
Response samples
application/json
{
  • "data": [
    ]
}
Copyright © Shipwell 2024. All right reserved.