Skip to main content
GET
Get a single 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

Response

OK

A webhook subscription that delivers event notifications to an external URL.

id
integer<int64>
required

The webhook's unique identifier

Required range: 1 <= x <= 9007199254740991
Example:

1

url
string<uri>
required

The URL event payloads are delivered to.

Example:

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

subscriptions
enum<string>[]
required

The event types this webhook receives. An empty array means the webhook receives 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>
required

Whether the webhook currently delivers events. A disabled webhook keeps its configuration but does not deliver events.

Available options:
active,
disabled
Example:

"active"

creator
PersonReference · object | null
required

The person who created the webhook. null when the creator is not recorded.

createdAt
string<date-time>
required

When the webhook was created.

Example:

"2026-01-01T00:00:00Z"

updatedAt
string<date-time> | null
required

When the webhook was last updated. null if the webhook has never been updated.

Example:

"2026-01-01T00:00:00Z"