Skip to main content
GET
/
api
/
v1
/
webhooks
/
logs
ListWebhookLogs
curl --request GET \
  --url https://your-sift-api-url.com/api/v1/webhooks/logs \
  --header 'Authorization: Bearer <token>'
{
  "logs": [
    {
      "webhookLogId": "<string>",
      "webhookId": "<string>",
      "eventId": "<string>",
      "organizationId": "<string>",
      "status": "WEBHOOK_LOG_STATUS_UNSPECIFIED",
      "payload": "<string>",
      "retryAttemptNumber": 123,
      "errorReason": "<string>",
      "sentDate": "2023-11-07T05:31:56Z",
      "createdDate": "2023-11-07T05:31:56Z",
      "modifiedDate": "2023-11-07T05:31:56Z",
      "createdByUserId": "<string>",
      "modifiedByUserId": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
pageSize
integer

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.

​
pageToken
string

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.

​
filter
string

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

​
orderBy
string

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"

Response

A successful response.

The response of a call to WebhookService_ListWebhookLogsResponse.

​
logs
object[]
required
​
nextPageToken
string
required