List all webhooks

Lists your webhooks, ordered by id (creation order) unless sort is given. Page through the results by following links.next and links.prev, which carry the cursor along with every filter, sort and limit from the request. page is still accepted for backwards compatibility; it pages by limit and cannot be combined with starting_after or ending_before.

SecurityAuthToken

Request

query Parameters

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 .. 200 ] Default: 25 The number of webhooks to return on this page. Values above 200 are treated as 200, and invalid values use the default.
page	integer >= 1 Deprecated 1-based page number, `limit` webhooks per page. Kept for backwards compatibility; follow `links.next` and `links.prev` instead.
sort	string Comma-separated fields to sort by, each optionally prefixed with `-` for descending. Allowed fields are `created_at`, `url`, `status`, `event_version` and `id`. Ties are broken by `id`. Example: sort=-created_at,url
id	string Only the webhook with this ID.
id.in	string Only webhooks with one of these IDs.
status	string Only webhooks with this status. Enum: "ENABLED" "DISABLED"
status.in	string Only webhooks with one of these statuses.
url	string Only webhooks with exactly this URL.
url.icontains	string Only webhooks whose URL contains this text, ignoring case.
event_version	integer Only webhooks with this event version.
enabled_events.contains	string Only webhooks whose `enabled_events` includes this event name.
enabled_events.in	string Only webhooks whose `enabled_events` includes at least one of these event names.
created_at.gt	string <date-time> Only webhooks created after this time. Must include a timezone.
created_at.gte	string <date-time> Only webhooks created at or after this time. Must include a timezone.
created_at.lt	string <date-time> Only webhooks created before this time. Must include a timezone.
created_at.lte	string <date-time> Only webhooks created at or before this time. Must include a timezone.

Responses

200

List all webhooks

Response Headers
Link	string Pagination links with `rel` values `first`, `prev`, `next` and `last`; a link is left out when its URL is null.

Response Schema: application/json

count required	integer The number of webhooks across all pages that match the filters. Kept for backwards compatibility; same value as `total_count`.
total_count required	integer The number of webhooks across all pages that match the filters.
next	string or null <uri> Deprecated Kept for backwards compatibility. A `page` link on first-page and `page` requests, otherwise the same as `links.next`. Use `links.next` instead.
previous	string or null <uri> Deprecated Kept for backwards compatibility. Use `links.prev` instead.
required	object
required	Array of objects (Webhook)

400

Invalid query parameter, such as a cursor that isn't one of your webhooks, both cursors at once, page with a cursor, or an invalid filter value. The error's source.parameter names the parameter.

get/webhooks/

Request samples

curl
Node.js
JavaScript
Python
Java

Response samples

application/json

{"count": 0,
"total_count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"links": {"next": "http://example.com",
"prev": "http://example.com",
"first": "http://example.com",
"last": "http://example.com",
"previous": "http://example.com"
},
"data": [{"id": "string",
"resource_type": "webhook",
"created_at": "2019-08-24T14:15:22Z",
"enabled_events": ["shipment.created",
"shipment.updated"
],
"error_contact_email": "user@example.com",
"username_password_authentication": {"username": "string",
"password": "string"
},
"status": "ENABLED",
"include_updated_object": false,
"url": "https://api.yourcompany.com/webhook_url",
"event_version": 1,
"custom_data": { },
"self_link": "string"
}
]
}