ATattio
Webhooks

Update a webhook

Changed on

Update a webhook and associated subscriptions.

Each combination of target URL, event type and filter must be unique within your workspace; duplicates are rejected with a 409. Changing the target URL re-checks the webhook's existing subscriptions against the new URL.

Required scopes: webhook:read-write.

Supported token levels: workspace.

patch/v2/webhooks/{webhook_id}

Request

  • Base URL
    https://api.attio.com
  • URL
    https://api.attio.com/v2/webhooks/{webhook_id}
  • Auth
    OAuth 2
    Authorization code: https://app.attio.com/authorize
    Token URL: https://app.attio.com/oauth/token scopes: webhook:read-write

Path parameters

webhook_idstring uuid required

A UUID which identifies the webhook.

Example:23e42eaf-323a-41da-b5bb-fd67eebda553

Request body

Example request

{
  "data": {
    "target_url": "https://example.com/webhook",
    "subscriptions": [
      {
        "event_type": "note.created"
      }
    ]
  }
}

Response

Success

Example response

{
  "data": {
    "target_url": "https://example.com/webhook",
    "subscriptions": [
      {
        "event_type": "note.created"
      }
    ],
    "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"
  }
}

Changes

  • 77d75a5d2529Revision changes
    • warning

      added the new activity-attribute.created enum value to the /// response property for the response status

    • warning

      added the new activity-attribute.updated enum value to the /// response property for the response status

    • warning

      added the new activity-record.created enum value to the /// response property for the response status

    • warning

      added the new activity-record.deleted enum value to the /// response property for the response status

    • warning

      added the new activity.created enum value to the /// response property for the response status

    • warning

      added the new activity.deleted enum value to the /// response property for the response status

    • warning

      added the new activity.updated enum value to the /// response property for the response status

    • info

      added the new activity-attribute.created enum value to the request property ///

    • info

      added the new activity-attribute.updated enum value to the request property ///

    • info

      added the new activity-record.created enum value to the request property ///

    • info

      added the new activity-record.deleted enum value to the request property ///

    • info

      added the new activity.created enum value to the request property ///

    • info

      added the new activity.deleted enum value to the request property ///

    • info

      added the new activity.updated enum value to the request property ///

  • 73d697a95766Revision changes
    • info

      added the non-success response with the status