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

person.created

You can filter by the group the person is added to.

// Notify only if the person is created in a group
// with the ID grp_bc984b3f-0386-434d-82d7-a91eb6badd71
{
  "eventType": "person.created",
  "filter": {
    "groupId": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71"
  }
}

person.updated

You can filter by:

The group the person is in
The updated attribute
The updated attribute and the value of the attribute

// Notify only if the person is updated while in a group
// with the ID grp_bc984b3f-0386-434d-82d7-a91eb6badd71
{
  "eventType": "person.updated",
  "filter": {
    "groupId": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71"
  }
}

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.

person.deleted

You can filter by the group the person is removed from.

// Notify only if the person is deleted while in a group
// with the ID grp_bc984b3f-0386-434d-82d7-a91eb6badd71
{
  "eventType": "person.deleted",
  "filter": {
    "groupId": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71"
  }
}

person.groups_updated

You can filter by the group the person is added to or removed from.

// Notify only if the person is added to or removed from the group
//  with the ID grp_bc984b3f-0386-434d-82d7-a91eb6badd71
{
  "eventType": "person.groups_updated",
  "filter": {
    "groupId": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71"
  }
}

person.workspace_interaction_metadata_updated

You can filter by the group the person is in.

// Notify only if the person's workspace interaction metadata
// is updated while in a group with the ID grp_bc984b3f-0386-434d-82d7-a91eb6badd71
{
  "eventType": "person.workspace_interaction_metadata_updated",
  "filter": {
    "groupId": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71"
  }
}

Company events

company.created

You can filter by the group the company is added to.

// Notify only if the company is created in a group
// with the ID grp_bc984b3f-0386-434d-82d7-a91eb6badd71
{
  "eventType": "company.created",
  "filter": {
    "groupId": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71"
  }
}

company.updated

You can filter by:

The group the company is in
The updated attribute
The updated attribute and the value of the attribute

// Notify only if the company is updated while in a group
// with the ID grp_bc984b3f-0386-434d-82d7-a91eb6badd71
{
  "eventType": "company.updated",
  "filter": {
    "groupId": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71"
  }
}

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.

company.deleted

You can filter by the group the company is removed from.

// Notify only if the company is deleted while in a group
// with the ID grp_bc984b3f-0386-434d-82d7-a91eb6badd71
{
  "eventType": "company.deleted",
  "filter": {
    "groupId": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71"
  }
}

company.groups_updated

You can filter by the group the company is added to or removed from.

// Notify only if the company is added to or removed from the group
//  with the ID grp_bc984b3f-0386-434d-82d7-a91eb6badd71
{
  "eventType": "company.groups_updated",
  "filter": {
    "groupId": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71"
  }
}

Deal events

object.created

You can filter by:

The group the deal is in
The group the deal is in and the object type

// Notify only if the deal is created while in a group
// with the ID grp_bc984b3f-0386-434d-82d7-a91eb6badd71
{
  "eventType": "object.created",
  "filter": {
    "groupId": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
  }
}

object.updated

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

// Notify only if the deal is updated while in a group
// with the ID grp_bc984b3f-0386-434d-82d7-a91eb6badd71
{
  "eventType": "object.updated",
  "filter": {
    "groupId": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
  }
}

Only the following attributes can be filtered:

name
customFieldValues

object.deleted

You can filter by:

The group the deal is in
The group the deal is in and the object type

// Notify only if the deal is deleted from the group
// with the ID grp_bc984b3f-0386-434d-82d7-a91eb6badd71
{
  "eventType": "object.deleted",
  "filter": {
    "groupId": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
  }
}