BIbindbee
Webhooks

List Webhook Logs

Changed on

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

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

page_sizeinteger

Number of results to return per page.

cursorstring nullable

The pagination cursor value.

webhook_idstring uuid nullable

Restrict results to deliveries for this webhook.

connector_idstring uuid nullable

Restrict results to deliveries triggered for this connector.

webhook_actionstring nullable

Comma-separated webhook event names to filter logs by.

Example:connector_synced,hris.employee.created
response_codestring nullable

Comma-separated HTTP response codes to filter logs by.

Example:200,403,503
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
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
errors_onlyboolean

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

The page size the request was served with (0 on an empty page). items can be shorter on the last page; cursor says whether another page exists.

Example response

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

Changes

  • 1f9bc0ad4bfbRevision changes
    • info

      added subschema #1 to the // response property anyOf list for the response status

    • info

      removed from the // response property anyOf list for the response status

  • a606b0cf18c9Revision changes
    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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