BObotbrains-io
Webhook Invocations

List Webhook Invocations

Changed on

Returns up to 7 days of invocations for a webhook.

get/api/v2/webhooks/{webhook_id}/invocations

Request

Path parameters

webhook_idstring required

Webhook id

Query parameters

filter[from_ts]string date-time

Filters invocations by from timestamp. Use ISO 8601 UTC format

filter[status]'unknown' | 'accepted' | 'success' | 'failed' | 'timeout' | 'circuit broken' | 'throttled' | 'client error' | 'server error'

Filters invocations by invocation status

filter[to_ts]string date-time

Filters invocations by timestamp. Use ISO 8601 UTC format

page[before]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.before_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[after]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.after_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[size]integer

Specifies how many records should be returned in the response. You can specify up to 100 records per page.

sort'latest_completed_at' | '-latest_completed_at'

Defines a invocation attribute to sort invocations

Response

Successful response

Changes

  • 9eac011b0efdRevision changes
    • breaking

      for the query request parameter page[size], default value 100 was added

    • breaking

      for the query request parameter page[size], the type changed from string to integer

    • warning

      for the query request parameter page[size], the max was set to 100.00

    • warning

      for the query request parameter page[size], the min was set to 1.00

  • e93a5ab6e2a5Revision changes
    • info

      endpoint added