Skip to main content
PUT
Update a webhook subscription

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials flow. Contact timeback@trilogy.com to request credentials for your application.

Path Parameters

sourcedApplicationId
string<uuid>
required

UUID of the App the subscription is tied to

subscriptionId
string<uuid>
required

UUID of the webhook subscription

Body

application/json

Partial update of a webhook subscription. At least one field is required.

url
string<uri>

New consumer endpoint.

Maximum string length: 2048
eventTypes
string[]

Replacement event-type filter.

Minimum array length: 1
status
enum<string>

Resume (active) or suspend (paused) the subscription. disabled is reserved for platform auto-disable.

Available options:
active,
paused

Response

The updated webhook subscription

A webhook subscription tied to an App's auth client.

id
string<uuid>
required

Unique identifier of the subscription.

url
string<uri>
required

Consumer endpoint the signed notification is POSTed to.

eventTypes
string[]
required

Event types this subscription receives.

status
enum<string>
required

active = delivering; paused = suspended by the owner; disabled = auto-disabled by the platform after repeated terminal delivery failures.

Available options:
active,
paused,
disabled
dateCreated
string<date-time>
required

When the subscription was created.