Search webhook deliveries

get

https://{tenant}.onechurchsoftware.com/api/webhooks/logs

Retrieve the delivery log of webhook events, including each delivery's payload, response and retry state. Requires an API license and permission to manage the API.

Required permission: API

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

Return deliveries whose id contains the given text.

url

string

Return deliveries whose target URL contains the given text.

method

string

Return deliveries using the given HTTP method.

event

string

Comma-delimited list of event codes (e.g. sermon_added).

webhook

string

Return deliveries for webhooks whose name contains the given text.

success

boolean

Whether the delivery succeeded.

created.start

date-time

Return deliveries attempted on or after this date.

created.end

date-time

Return deliveries attempted on or before this date.

attempts

int32

≥ 1

Return deliveries with exactly this many attempts.

retry.start

date-time

Return deliveries retrying on or after this date.

retry.end

date-time

Return deliveries retrying on or before this date.

skip

int32

≥ 0

The number of records to skip before returning results, used for paging.

limit

int32

≥ 0

The maximum number of records to return per page. Defaults to 50.

sort.property

string

The field to sort the results by. The default field depends on the endpoint.

sort.dir

string

enum

The sort direction: "asc" or "desc".

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

200OK