API Reference
  1. One Church Software API
  2. Webhooks

Search webhooks

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

Retrieve the webhooks registered on the account, with each webhook's subscribed events and delivery statistics. Requires an API license and permission to manage the API.

Required permission: API

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Return webhooks whose target URL contains the given text.

boolean

Whether the webhook sends basic-auth credentials with deliveries.

boolean

Whether the webhook is enabled.

int32
≥ 0

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

int32
≥ 0

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

string

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

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.

Updated about 2 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated about 2 months ago

Did this page help you?