Sift | Docs
APIReferenceREST (HTTP/JSON)Webhook service

ListWebhooks

Retrieve and optionally filter a list of webhooks.

GET
/api/v1/webhooks

Query Parameters

pageSizeinteger

The maximum number of webhooks to return. The service may return fewer than this value. If unspecified, at most 50 runs will be returned. The maximum value is 1000.

Format: "int64"

pageTokenstring

A page token, received from a previous ListWebhooks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListWebhooks must match the call that provided the page token.

filterstring

A Common Expression Language (CEL) filter string. Available fields to filter by are webhook_id, name, and event_type.

orderBystring

How to order the retrieved webhooks. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available field to order_by is created_date. If left empty, items are ordered by created_date in ascending order (oldest-first). For more information about the format of this field, read this Example: "created_date desc"

curl -X GET "<API_URL>/api/v1/webhooks?pageSize=0&pageToken=string&filter=string&orderBy=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "webhooks": [
    {
      "webhookId": "string",
      "organizationId": "string",
      "targetUrl": "string",
      "name": "string",
      "eventType": "WEBHOOK_EVENT_TYPE_UNSPECIFIED",
      "payload": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z",
      "archivedDate": "2019-08-24T14:15:22Z",
      "createdByUserId": "string",
      "modifiedByUserId": "string",
      "httpHeaders": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "nextPageToken": "string"
}

Previous

ListWebhookLogs GET

Next

ToggleWebhookSignatureKeyActivation PUT