List webhooks

curl --request GET \
  --url https://api.attio.com/v2/webhooks \
  --header 'Authorization: Bearer <token>'

{
  "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"
    }
  ]
}

GET

webhooks

List webhooks

curl --request GET \
  --url https://api.attio.com/v2/webhooks \
  --header 'Authorization: Bearer <token>'

{
  "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"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Query Parameters

limit

integer

The maximum number of results to return, between 10 and 100, defaults to 10. See the full guide to pagination here.

Example:

10

offset

integer

The number of results to skip over before returning, defaults to 0. See the full guide to pagination here.

Example:

5

Response

200 - application/json

Success

data

object[]

required

Show child attributes

data.target_url

string<uri>

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.

Show child attributes

data.subscriptions.event_type

enum<string>

required

Type of event the webhook is subscribed to.

Available options:

call-recording.created,

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-content.updated,

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

required

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

Option 1
Option 2

Show child attributes

data.subscriptions.filter.$or

object[]

required

Option 1
Option 2

Show child attributes

data.subscriptions.filter.$or.field

string

required

data.subscriptions.filter.$or.operator

enum<string>

required

Available options:

equals

data.subscriptions.filter.$or.value

string

required

Example:

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

data.id

object

required

Show child attributes

data.id.workspace_id

string<uuid>

required

The ID of the workspace the webhook belongs to.

Example:

"14beef7a-99f7-4534-a87e-70b564330a4c"

data.id.webhook_id

string<uuid>

required

The ID of the webhook.

Example:

"23e42eaf-323a-41da-b5bb-fd67eebda553"

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"

Get call transcript Create a webhook

⌘I

Introduction

Guides

Tutorials

Endpoint reference

Webhook reference

List webhooks

Authorizations

Query Parameters

Response