Sign in

v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB
Webhooks

List Webhook Logs

List webhook delivery attempts for the caller's organization. Filter by webhook_id (see GET /webhooks for available ids) or connector_id to narrow the results.

get/api/v1/webhooks/logs

Query parameters

webhook_idstring uuid nullable

Restrict results to deliveries for this webhook.

Restrict results to deliveries for this webhook.

page_sizeinteger

Number of results to return per page.

Number of results to return per page.

cursorstring

The pagination cursor value.

The pagination cursor value.

connector_idstring uuid nullable

Restrict results to deliveries triggered for this connector.

Restrict results to deliveries triggered for this connector.

webhook_actionstring nullable

Comma-separated webhook event types to filter logs by.

Example:connector_synced,employee_data_changed

Comma-separated webhook event types to filter logs by.

response_codestring

Comma-separated HTTP response codes to filter logs by.

Example:200,403,503

Comma-separated HTTP response codes to filter logs by.

created_at_fromstring

Only logs created at or after this datetime. Format: ISO 8601.

Example:2024-02-21T21:22:12.993Z

Only logs created at or after this datetime. Format: ISO 8601.

created_at_tostring

Only logs created at or before this datetime. Format: ISO 8601.

Example:2024-02-21T21:22:12.993Z

Only logs created at or before this datetime. Format: ISO 8601.

errors_onlyboolean

If true, only error logs (HTTP response code >= 400) are returned.

If true, only error logs (HTTP response code >= 400) are returned.

Response

Successful Response

cursorstring nullable required

Cursor value to fetch next set of items

page_sizeinteger required

Indicates the count of items in the response

Example response

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50
}