Subscribe to a webhook event

post

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

Creates a REST-hook subscription bound to the calling API key. Must be called with an API
key rather than a user token, since the subscription is owned by the key. Returns the
subscription id and a secret, shown only once at creation. The secret is reserved for
future payload signing and is not used to sign deliveries today.

A subscription created here behaves differently from a webhook configured in the
Developers UI in one important way: if the endpoint answers 410 Gone, the subscription
is deleted automatically rather than disabled, on the assumption the integration
removed it deliberately.

Failed deliveries are retried with backoff. After five consecutive deliveries exhaust
their retries the subscription is disabled and no further events are sent to it.

Requires an API license and permission to manage the API.

Required permission: API

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The callback URL and the event code to subscribe to.

Request body to create a REST-hook subscription (used by Zapier and other integrations).

url

string | null

The endpoint that will receive the event payloads. Must be an absolute https URL;
anything else is rejected.

event

string | null

The event code to subscribe to. Current codes are person_created,
person_updated, contribution_created, pledge_created,
form_entry_submitted, connection_created, group_member_added,
event_registration_created, and the sermon events sermon_added,
sermon_edited, sermon_deleted, sermon_audio_edited,
sermon_audio_deleted, sermon_video_edited, sermon_video_deleted,
sermon_image_edited, sermon_image_deleted. Availability is per account, so a
code that is not enabled for yours is rejected rather than silently ignored.

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.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK