Deployments.ai Docs
Runtime

List webhook subscriptions

GET /v1/webhooks · SDK listWebhooks · CLI deployments webhook list

GET
/v1/webhooks

Requires webhooks:read.

Authorization

headerAuthorizationBearer <token>

Opaque bearer credential scoped to one service account and tenant.

Query Parameters

cursor?string

Opaque cursor returned by the previous page.

Length1 <= length <= 4096
limit?integer

Maximum number of resources to return.

Range1 <= value <= 100

Header Parameters

x-deployments-environment?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-organization?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-project?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

ListWebhooksResponse

application/json
  1. response
nextCursor?|null
webhooks*array<>
curl -X GET "https://example.com/v1/webhooks"
{  "nextCursor": "string",  "webhooks": [    {      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "version": 0,      "environmentId": "string",      "organizationId": "string",      "projectId": "string",      "consecutiveFailures": 0,      "disabledAt": "2019-08-24T14:15:22Z",      "disabledReason": "consecutive-failures",      "eventTypes": [        "string"      ],      "id": "string",      "name": "string",      "object": "webhook-endpoint",      "previousSigningSecretExpiresAt": "2019-08-24T14:15:22Z",      "resourceFilters": {        "aggregateIds": [          "string"        ],        "aggregateTypes": [          "string"        ],        "environmentIds": [          "string"        ],        "projectIds": [          "string"        ]      },      "signingSecretRotatedAt": "2019-08-24T14:15:22Z",      "status": "active",      "url": "string"    }  ]}