Sift | Docs
APIReferenceREST (HTTP/JSON)Webhook service

ListWebhookLogs

Retrieve and optionally filter a list of webhook logs.

GET
/api/v1/webhooks/logs

Query Parameters

pageSizeinteger

The maximum number of webhook logs 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 ListWebhookLogs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListWebhookLogs must match the call that provided the page token.

filterstring

A Common Expression Language (CEL) filter string. The available fields to filter by are webhook_id, status.

orderBystring

How to order the retrieved webhook logs. 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/logs?pageSize=0&pageToken=string&filter=string&orderBy=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "logs": [
    {
      "webhookLogId": "string",
      "webhookId": "string",
      "eventId": "string",
      "organizationId": "string",
      "status": "WEBHOOK_LOG_STATUS_UNSPECIFIED",
      "payload": "string",
      "retryAttemptNumber": 0,
      "errorReason": "string",
      "sentDate": "2019-08-24T14:15:22Z",
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z",
      "createdByUserId": "string",
      "modifiedByUserId": "string"
    }
  ],
  "nextPageToken": "string"
}

Previous

GetWebhookSignatureKey GET

Next

ListWebhooks GET