Skip to main content
POST
Create a webhook
Create a webhook to be notified about events that occur in the workspace. To learn more about webhooks, how to set them up and receive notifications, check out the webhooks guide.

Available events

You can find the list of available events in the webhook events and payloads guide.

Filters

You can add filters to events in order to narrow down the notifications you receive. Filters allow you to achieve advanced workflow capabilities, such as:
  • Only receive notifications when a person is added to a specific group.
  • Only receive notifications when a company is moved to a specific pipeline status.
  • Only receive notifications when a deal from a specific group is updated.
Each event type has a different set of filters that can be used. Click on the event types below to see the filters available.
Filters are only available through the API. If you add filters and then update the events from the settings page, the filters will be lost.

Person events

You can filter by the group the person is added to.
You can filter by:
  • The group the person is in
  • The updated attribute
  • The updated attribute and the value of the attribute
Only the following attributes can be filtered:
  • firstName
  • lastName
  • birthday
  • jobTitle
  • description - You cannot provide a value for this attribute
  • addresses
  • emails
  • phones
  • urls
  • customFieldValues
When passing a value for these fields, you must provide the value in the correct format. Refer to the update person documentation for more information.
You can filter by the group the person is removed from.
You can filter by the group the person is added to or removed from.
You can filter by the group the person is in.

Company events

You can filter by the group the company is added to.
You can filter by:
  • The group the company is in
  • The updated attribute
  • The updated attribute and the value of the attribute
Only the following attributes can be filtered:
  • name
  • description - You cannot provide a value for this attribute
  • addresses
  • emails
  • phones
  • urls
  • fundingRaised
  • lastFundingDate
  • foundationYear
  • employeeRange
  • industry
  • customFieldValues
When passing a value for these fields, you must provide the value in the correct format. Refer to the update company documentation for more information.
You can filter by the group the company is removed from.
You can filter by the group the company is added to or removed from.

Deal events

You can filter by:
  • The group the deal is in
  • The group the deal is in and the object type
You can filter by:
  • The group the deal is in
  • The group the deal is in and the object type
  • Group, object type and the updated attribute
  • Group, object type, the updated attribute and the value of the attribute
Only the following attributes can be filtered:
  • name
  • customFieldValues
You can filter by:
  • The group the deal is in
  • The group the deal is in and the object type

Note events

There are no filters available for this event at the moment.
There are no filters available for this event at the moment.
There are no filters available for this event at the moment.

Reminder events

There are no filters available for this event at the moment.
There are no filters available for this event at the moment.
There are no filters available for this event at the moment.
There are no filters available for this event at the moment.

Authorizations

Authorization
string
header
required

API key for authentication

Body

application/json
name
string
required

A friendly name for the webhook.

Maximum string length: 255
Example:

"My app integration"

targetUrl
string<uri>
required

The URL of the webhook. It must be a publicly accessible URL using the HTTP or HTTPS protocol.

Maximum string length: 2048
Example:

"https://my-app.com/webhook"

subscribedEvents
object[]
required

The events the webhook is subscribed to, with optional filters.

Required array length: 1 - 20 elements
Example:

Response

The created webhook.

data
object
required

A webhook with a visible signing secret.

Example:
deprecations
string[]
Example: