BObotbrains-io
Webhooks

List Webhooks

Changed on

List webhooks.

get/api/v2/webhooks

Request

Query parameters

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.

filter[name_contains]string

Filters the webhooks by a string in the name

filter[status]'active' | 'inactive'

Filters the webhooks by webhook status

sort'name' | 'status'

Defines the sorting criteria. Only supports name and status

Response

Successful response

Changes

  • a67ea66f0a52Revision changes
    • breaking

      the response property /////// became optional for the status

    • breaking

      the response property /////// became optional for the status

    • breaking

      the response property /////// became optional for the status

  • 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

    • breaking

      added to the // response property oneOf list for the response status

    • 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

    • info

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