List webhooks

GET /notifications/v1/webhooks

The listWebhooks operation returns a list of all the webhooks that are visible to the current user.

Query parameters

Paginated results

When a cursor property appears in the response, it indicates that more results are available. To access the next page of results, send a follow-up request that includes the cursor query parameter, setting it equal to the cursor value from the previous response. On success, the next page of results is returned, potentially including a new cursor to continue walking the list.

You can customize the number of returned catalog items by providing a limit query parameter, which specifies the maximum number of items to return in the response.

By default, up to 10 webhooks are returned in each response.

Enter the following curl command, remembering to replace the ${VARNAME} variables with the appropriate values:

curl --location "${API_BASE_URL}/api/notifications/v1/webhooks" \
--header "Accept: application/json, application/problem+json" \
--header "Authorization: Bearer ${API_ACCESS_TOKEN}" \
--data-urlencode "cursor=XXXXXXXXXX" \
--data-urlencode "limit=20"

Example

Request

Enter the following curl command, remembering to replace the ${VARNAME} variables with the appropriate values:

curl --location "${API_BASE_URL}/api/notifications/v1/webhooks" \
--header "Accept: application/json, application/problem+json" \
--header "Authorization: Bearer ${API_ACCESS_TOKEN}"

Response

On success, returns a 200 status code and a JSON object containing an array of webhook records.

{
  "data": [
    {
      "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "createdAt": "2006-01-02T15:04:05Z07:00",
      "updatedAt": "2006-01-02T15:04:05Z07:00",
      "targetURL": "https://example.com/notify",
      "auth": {
        "type": "basic",
        "username": "USERNAME"
      },
      "status": "active"
    }
  ]
}