List webhook endpoints

GET

/api/v1/webhook-endpoints

Every endpoint of the organization, newest first. There are at most 5, so the list is not paginated.

Required scope: webhooks:read (webhooks:write also works).

Errors

401: authentication_required, invalid_api_key
403: api_access_disabled, insufficient_scope
429: rate_limit_exceeded
500: api_error
503: service_unavailable

Authorization

ApiKey

headerAuthorizationBearer <probb_live_<id>_<secret>>

Response Body

Success.

application/json

response

object*string

data*array<>

hasMore*boolean

nextCursor*null

Example Request

# Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.
curl --fail-with-body -X GET "$PROBB_URL/api/v1/webhook-endpoints" \
  -H "Authorization: Bearer $PROBB_API_KEY"

Example Request

# Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.curl --fail-with-body -X GET "$PROBB_URL/api/v1/webhook-endpoints" \  -H "Authorization: Bearer $PROBB_API_KEY"

Example ResponseSchema

{
  "object": "list",
  "data": [
    {
      "object": "webhook_endpoint",
      "id": "string",
      "url": "string",
      "description": "string",
      "events": [
        "string"
      ],
      "status": "active",
      "revision": "string",
      "previousSecretExpiresAt": "2019-08-24T14:15:22Z",
      "secretRotatedAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "hasMore": false,
  "nextCursor": null
}

{  "object": "list",  "data": [    {      "object": "webhook_endpoint",      "id": "string",      "url": "string",      "description": "string",      "events": [        "string"      ],      "status": "active",      "revision": "string",      "previousSecretExpiresAt": "2019-08-24T14:15:22Z",      "secretRotatedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "hasMore": false,  "nextCursor": null}

List webhook endpoints

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Response Body