Webhooks

List webhooks configured for the caller's organization.

get/api/v1/webhooks

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

is_activeboolean nullable

Filter webhooks by active status.

Example:true
page_sizeinteger

Number of results to return per page.

cursorstring nullable

The pagination cursor value.

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,
  "items": [
    {
      "webhook_id": "018e586b-7d0b-7bc9-be65-a8fdbc82d734",
      "environments": [
        "production"
      ],
      "version": "2025.01.01"
    }
  ]
}

Changes

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

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

    • info

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