Skip to main content
GET
List Logs for a Webhook
Use it to confirm an event was sent and to find the log entry to inspect.

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path Parameters

id
integer<int64>
required

The ID of the webhook.

Query Parameters

Filter
string

Search term, trimmed before matching. A number matches the record ID the delivery was for (contextId, such as a gift or donor ID), including manual resends; a number from 100 to 599 also matches httpStatusCode; and any number matches webhook names that contain it. A number doesn't match the log entry's own id. Text matches the event type by name (Gift Added or Gift_Added, case-insensitive) and webhook names that contain it.

Skip
integer<int32>

The number of records to skip before the first record returned. Use it with take to page through the results.

Take
integer<int32>

The maximum number of records to return in this page of results.

SortBy
enum<string>

Field to sort by (case-insensitive). Valid options: createddatetime, id

Available options:
createddatetime,
id
Descending
boolean

The direction to sort the results. Set to true to sort in descending order.

IncludeDetails
boolean

When true, includes the related records for each item in the response. Not every list has extra records to return, and it can slow down large result sets.

Response

OK

A page of log entries with the total number that match the request.

items
object[]

The log entries in this page of results.

Represents a webhook log list model.

total
integer<int32>

The total number of log entries that match the request. Use it with skip and take to page through the full set.