Create a webhook

POST

webhooks

curl --request POST \
  --url https://api.attio.com/v2/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {
    "target_url": "https://example.com/webhook",
    "subscriptions": [
      {
        "event_type": "note.created",
        "filter": {
          "$and": [
            {
              "field": "parent_object_id",
              "operator": "equals",
              "value": "97052eb9-e65e-443f-a297-f2d9a4a7f795"
            }
          ]
        }
      }
    ]
  }
}'

{
  "data": {
    "target_url": "https://example.com/webhook",
    "subscriptions": [
      {
        "event_type": "note.created",
        "filter": {
          "$and": [
            {
              "field": "parent_object_id",
              "operator": "equals",
              "value": "97052eb9-e65e-443f-a297-f2d9a4a7f795"
            }
          ]
        }
      }
    ],
    "id": {
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
      "webhook_id": "23e42eaf-323a-41da-b5bb-fd67eebda553"
    },
    "status": "active",
    "created_at": "2023-04-27T13:22:49.061281000Z",
    "secret": "ca978112ca1bbdcafac231b39a23dc4da786eff8147c4e72b9807785afee48bb"
  }
}

Authorizations

Authorization

string

header

required

This API uses OAuth 2.0 with the authorization code grant flow.

Body

application/json

data

object

required

data.target_url

string

required

URL where the webhook events will be delivered to.

Example:

"https://example.com/webhook"

data.subscriptions

object[]

required

One or more events the webhook is subscribed to.

data.subscriptions.event_type

enum<string>

required

Type of event the webhook is subscribed to.

Available options:

comment.created,

comment.resolved,

comment.unresolved,

comment.deleted,

list.created,

list.updated,

list.deleted,

list-attribute.created,

list-attribute.updated,

list-entry.created,

list-entry.updated,

list-entry.deleted,

object-attribute.created,

object-attribute.updated,

note.created,

note.updated,

note.deleted,

record.created,

record.merged,

record.updated,

record.deleted,

task.created,

task.updated,

task.deleted,

workspace-member.created

Example:

"note.created"

data.subscriptions.filter

object | null

required

Filters to determine whether the webhook event should be sent. If null, the filter always passes.

Example:

{
  "$and": [
    {
      "field": "parent_object_id",
      "operator": "equals",
      "value": "97052eb9-e65e-443f-a297-f2d9a4a7f795"
    }
  ]
}

Response

200

application/json

Success

data

object

required

data.target_url

string

required

URL where the webhook events will be delivered to.

Example:

"https://example.com/webhook"

data.subscriptions

object[]

required

One or more events the webhook is subscribed to.

data.subscriptions.event_type

enum<string>

required

Type of event the webhook is subscribed to.

Available options:

comment.created,

comment.resolved,

comment.unresolved,

comment.deleted,

list.created,

list.updated,

list.deleted,

list-attribute.created,

list-attribute.updated,

list-entry.created,

list-entry.updated,

list-entry.deleted,

object-attribute.created,

object-attribute.updated,

note.created,

note.updated,

note.deleted,

record.created,

record.merged,

record.updated,

record.deleted,

task.created,

task.updated,

task.deleted,

workspace-member.created

Example:

"note.created"

data.subscriptions.filter

object | null

required

Filters to determine whether the webhook event should be sent. If null, the filter always passes.

Example:

{
  "$and": [
    {
      "field": "parent_object_id",
      "operator": "equals",
      "value": "97052eb9-e65e-443f-a297-f2d9a4a7f795"
    }
  ]
}

data.id

object

required

data.status

enum<string>

required

The state of the webhook. Webhooks marked as active and degraded will receive events, inactive ones will not. If a webhook remains in the degraded state for 7 days, it will be marked inactive.

Available options:

active,

degraded,

inactive

Example:

"active"

data.created_at

string

required

When the webhook was created.

Example:

"2023-04-27T13:22:49.061281000Z"

data.secret

string

required

The key which is used to sign the webhook events. This is only shown when setting up the webhook initially.

Example:

"ca978112ca1bbdcafac231b39a23dc4da786eff8147c4e72b9807785afee48bb"

List webhooks Get a webhook

curl --request POST \
  --url https://api.attio.com/v2/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {
    "target_url": "https://example.com/webhook",
    "subscriptions": [
      {
        "event_type": "note.created",
        "filter": {
          "$and": [
            {
              "field": "parent_object_id",
              "operator": "equals",
              "value": "97052eb9-e65e-443f-a297-f2d9a4a7f795"
            }
          ]
        }
      }
    ]
  }
}'

{
  "data": {
    "target_url": "https://example.com/webhook",
    "subscriptions": [
      {
        "event_type": "note.created",
        "filter": {
          "$and": [
            {
              "field": "parent_object_id",
              "operator": "equals",
              "value": "97052eb9-e65e-443f-a297-f2d9a4a7f795"
            }
          ]
        }
      }
    ],
    "id": {
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
      "webhook_id": "23e42eaf-323a-41da-b5bb-fd67eebda553"
    },
    "status": "active",
    "created_at": "2023-04-27T13:22:49.061281000Z",
    "secret": "ca978112ca1bbdcafac231b39a23dc4da786eff8147c4e72b9807785afee48bb"
  }
}

Objects

Attributes

Records

Lists

Entries

Workspace members

Notes

Tasks

Threads

Comments

Webhooks

Meta

Authorizations

Body

Response