Sign in
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

page_sizeinteger

Number of results to return per page.

Number of results to return per page.

cursorstring nullable

The pagination cursor value.

The pagination cursor value.

webhook_idstring uuid nullable

Restrict results to deliveries for this webhook.

Restrict results to deliveries for this webhook.

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 nullable

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 nullable

Only logs created at or after this datetime. Format: ISO 8601. If no timezone offset is supplied, the value is interpreted as UTC.

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

Only logs created at or after this datetime. Format: ISO 8601. If no timezone offset is supplied, the value is interpreted as UTC.

created_at_tostring nullable

Only logs created at or before this datetime. Format: ISO 8601. If no timezone offset is supplied, the value is interpreted as UTC.

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

Only logs created at or before this datetime. Format: ISO 8601. If no timezone offset is supplied, the value is interpreted as UTC.

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
}

Changes

Changed in 3 of the 11 revisions of this API.12

  • a606b0cf18c98See the full diff
    • ○

      query request parameter created_at_from list-of-types was widened by adding types null

      request-parameter-list-of-types-widened

    • ○

      query request parameter created_at_to list-of-types was widened by adding types null

      request-parameter-list-of-types-widened

    • ○

      query request parameter cursor list-of-types was widened by adding types null

      request-parameter-list-of-types-widened

    • ○

      query request parameter response_code list-of-types was widened by adding types null

      request-parameter-list-of-types-widened

    • ○

      for the query request parameter created_at_from, the type/format was generalized from string/ to /

      request-parameter-type-generalized

    • ○

      for the query request parameter created_at_to, the type/format was generalized from string/ to /

      request-parameter-type-generalized

    • ○

      for the query request parameter cursor, the type/format was generalized from string/ to /

      request-parameter-type-generalized

    • ○

      for the query request parameter response_code, the type/format was generalized from string/ to /

      request-parameter-type-generalized

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • eb3486b88e553See the full diff
    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

  • 4251032050261See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog