Skip to main content
GET
/
v1
/
webhooks
List webhooks
curl --request GET \
  --url https://instance.prod.onboardapp.io/v1/webhooks \
  --header 'X-API-KEY: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "url": "<string>",
      "events": [
        "case.created"
      ],
      "status": "active",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "request_id": "req_9k4m2n1p3q",
    "page": {
      "cursor": "<string>",
      "has_more": true
    }
  }
}

Authorizations

​
X-API-KEY
string
header
required

Project-scoped API key for server-to-server authentication. Obtain keys from the Zenoo dashboard under Project Settings > API Keys. Staging and production environments use separate keys.

Query Parameters

​
cursor
string

Pagination cursor from a previous response. Pass to fetch the next page.

​
limit
integer
default:25

Maximum number of items to return per page.

Required range: 1 <= x <= 100

Response

List of webhooks.

Standard response wrapper for all API endpoints. Contains the resource data and pagination metadata.

​
data
object[]

Response payload. Type varies by endpoint.

​
meta
object