Skip to main content
POST
Update a Webhook

Authorizations

Authorization
string
header
required

A static Affinity API key, presented as a bearer token.

Path Parameters

webhookId
integer<int64>
required

Webhook ID

Required range: 1 <= x <= 9007199254740991

Body

application/json

Partial-update request body for a webhook. Only provided properties are updated. Changing url on an active webhook, or setting status to active on a disabled webhook, triggers a test delivery that validates the URL before the update is applied.

url
string<uri>

New delivery URL for the webhook. Must be unique within the organization.

Example:

"https://example.com/affinity-events"

subscriptions
enum<string>[]

New set of event types the webhook receives. An empty array subscribes the webhook to all event types.

Maximum array length: 100

An event type a webhook can subscribe to. Values match the type field of delivered webhook payloads and are shared with the v1 webhook API.

Available options:
list.created,
list.updated,
list.deleted,
list_entry.created,
list_entry.deleted,
note.created,
note.updated,
note.deleted,
field.created,
field.updated,
field.deleted,
field_value.created,
field_value.updated,
field_value.deleted,
person.created,
person.updated,
person.deleted,
organization.created,
organization.updated,
organization.deleted,
organization.merged,
opportunity.created,
opportunity.updated,
opportunity.deleted,
file.created,
file.deleted,
smart_interaction_value.updated,
reminder.created,
reminder.updated,
reminder.deleted
status
enum<string>

Set to disabled to pause event delivery, or active to resume it.

Available options:
active,
disabled
Example:

"active"

Response

No Content