---
title: "Webhooks API Reference | Linkbreakers"
description: "Your own URLs, called with each event you subscribe them to (scans, visits, form submissions)."
canonical: "https://linkbreakers.com/help/api/webhooks"
---

# Webhooks

Your own URLs, called with each event you subscribe them to (scans, visits, form submissions).

6 entries on this page

## The webhook object

Describes a webhook endpoint that receives event notifications when specified conditions are met, providing real-time integration capabilities for external systems.

`createdAt` string (date-time) 

Read-only

The timestamp when the webhook was created

`createdBy` string

The member who created the webhook (UUID)

`delivery` object

Where, when and what it sends.

8 child attributes

`directoryIds` array of string

Where: directories it applies to, with every directory below them.

`linkIds` array of string

Where: links it applies to. All three lists empty means every link.

`moments` array of enum

When: the moments of a visit it sends at. Ignored when stepIds is set.

`stepIds` array of string

When: send only when a visit reaches one of these workflow steps.

`tagIds` array of string

Where: tags it applies to.

`targetsGone` boolean 

Read-only

Every link, directory and tag chosen has since been deleted, so this covers nothing. The lists above are then empty without meaning every link.

`visitorAttributeKeys` array of string

What: with SELECTED, the attribute keys sent, such as "$email" or "rating".

`visitorData` enum

How much of what is known about the visitor an integration sends.

Allowed values

* `INTEGRATION_VISITOR_DATA_NONE` Only the visit: the link, the step, the device and the place.
* `INTEGRATION_VISITOR_DATA_ALL` The visit, and every attribute known about the visitor.
* `INTEGRATION_VISITOR_DATA_SELECTED` The visit, and only the attributes named in visitorAttributeKeys.

`endpointUrl` string

The URL endpoint that will receive webhook POST requests

`failureCount` integer (int64) 

Read-only

Count of failed webhook deliveries

`id` string

The unique identifier of the webhook (UUID)

`lastDeliveredAt` string (date-time) 

Read-only

The timestamp when the webhook was last successfully delivered to the endpoint. This field is only updated when the webhook endpoint responds with a 2xx status code. Use this to track actual successful event notifications to external systems.

`lastSentAt` string (date-time) 

Read-only

The timestamp when the webhook was last triggered (attempted), regardless of success or failure. This field is updated on every webhook transmission attempt, including failed deliveries. Use this to track webhook activity and debugging transmission issues.

`linkId` string

Filter webhook notifications by a specific link ID. Only events from this link will trigger webhook notifications. If empty, all links in the workspace will trigger notifications.

`name` string

The name of the webhook

`source` enum

Source of the webhook - indicates whether it was created manually through the dashboard or automatically via an integration platform

Allowed values

* `WEBHOOK_SOURCE_LINKBREAKERS` Webhook created manually through the Linkbreakers dashboard/platform
* `WEBHOOK_SOURCE_MAKE` Webhook created automatically via Make.com integration
* `WEBHOOK_SOURCE_ZAPIER` Webhook created automatically via Zapier integration
* `WEBHOOK_SOURCE_N8N` Webhook created automatically by the Linkbreakers node in n8n
* `WEBHOOK_SOURCE_INTEGRATELY` Webhook created automatically via Integrately
* `WEBHOOK_SOURCE_UNSPECIFIED` Webhook source not specified (defaults to LINKBREAKERS)

`status` enum

Current status of the webhook

Allowed values

* `WEBHOOK_STATUS_ACTIVE` Webhook is active and receiving events
* `WEBHOOK_STATUS_DISABLED` Webhook is disabled due to repeated failures
* `WEBHOOK_STATUS_PAUSED` Webhook is paused by user action

`successCount` integer (int64) 

Read-only

Count of successful webhook deliveries

`triggers` array of enum

Filter webhook notifications by workflow step kinds. Only workflow steps matching these kinds will trigger webhook notifications: KIND\_ENTRY sends visit.entered, KIND\_INTERACTION visit.interacted, KIND\_CONDITION visit.routed and KIND\_EXIT visit.exited. If empty, all workflow step kinds will trigger notifications.

`updatedAt` string (date-time) 

Read-only

The timestamp when the webhook was last updated

`workspaceId` string

The workspace ID the webhook belongs to (UUID)

Example webhook

```json
{
  "createdAt": "2026-01-15T09:30:00Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "delivery": {
    "directoryIds": [
      "string"
    ],
    "linkIds": [
      "string"
    ],
    "moments": [
      "KIND_ENTRY"
    ],
    "stepIds": [
      "string"
    ],
    "tagIds": [
      "string"
    ],
    "targetsGone": false,
    "visitorAttributeKeys": [
      "string"
    ],
    "visitorData": "INTEGRATION_VISITOR_DATA_NONE"
  },
  "endpointUrl": "https://api.example.com/webhooks/linkbreakers",
  "failureCount": 0,
  "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
  "lastDeliveredAt": "2026-01-15T09:30:00Z",
  "lastSentAt": "2026-01-15T09:30:00Z",
  "linkId": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
  "name": "Production Event Notifications",
  "source": "WEBHOOK_SOURCE_LINKBREAKERS",
  "status": "WEBHOOK_STATUS_ACTIVE",
  "successCount": 0,
  "triggers": [
    "KIND_ENTRY",
    "KIND_EXIT"
  ],
  "updatedAt": "2026-01-15T09:30:00Z",
  "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
}
```

### Parameters

`status` string 

query

Filter by webhook status (optional)

* WEBHOOK\_STATUS\_UNSPECIFIED: Webhook status not specified
* WEBHOOK\_STATUS\_ACTIVE: Webhook is active and receiving events
* WEBHOOK\_STATUS\_DISABLED: Webhook is disabled due to repeated failures
* WEBHOOK\_STATUS\_PAUSED: Webhook is paused by user action

`pageSize` integer (int64) 

query

Maximum number of webhooks to return. Defaults to 100, capped at 1000.

`pageToken` string 

query

Cursor from a previous response's nextPageToken. Empty starts at the first page. Pages are ordered by (createdAt, id), which never change, so a record cannot move between pages while a client is walking them.

`cursor` string 

query

Opaque cursor from the previous page's nextPageToken. Same as pageToken; when both are sent, pageToken wins.

### Response

200

`nextPageToken` string

Cursor to continue listing webhooks. Empty on the last page.

`totalCount` integer (int64)

How many records exist in total, so a client can tell a complete answer from a page of one. A local-first client reads absence from this list as deletion, and may only do so when the count it was given matches what it received: without that, one page would look like the whole model and everything beyond it would be removed locally.

`webhooks` array of object

Webhooks scoped to the calling workspace

Fields: [The webhook object](#webhooks-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X GET "https://api.linkbreakers.com/v1/webhooks" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

Response 200

```json
{
  "nextPageToken": "string",
  "totalCount": 0,
  "webhooks": [
    {
      "createdAt": "2026-01-15T09:30:00Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "delivery": {
        "directoryIds": [
          "string"
        ],
        "linkIds": [
          "string"
        ],
        "moments": [
          "KIND_ENTRY"
        ],
        "stepIds": [
          "string"
        ],
        "tagIds": [
          "string"
        ],
        "targetsGone": false,
        "visitorAttributeKeys": [
          "string"
        ],
        "visitorData": "INTEGRATION_VISITOR_DATA_NONE"
      },
      "endpointUrl": "https://api.example.com/webhooks/linkbreakers",
      "failureCount": 0,
      "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
      "lastDeliveredAt": "2026-01-15T09:30:00Z",
      "lastSentAt": "2026-01-15T09:30:00Z",
      "linkId": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
      "name": "Production Event Notifications",
      "source": "WEBHOOK_SOURCE_LINKBREAKERS",
      "status": "WEBHOOK_STATUS_ACTIVE",
      "successCount": 0,
      "triggers": [
        "KIND_ENTRY",
        "KIND_EXIT"
      ],
      "updatedAt": "2026-01-15T09:30:00Z",
      "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
    }
  ]
}
```

### Parameters

`id` string 

path

Required

Identifier of the desired webhook (UUID)

### Response

200

`webhook` object

Webhook details

Fields: [The webhook object](#webhooks-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X GET "https://api.linkbreakers.com/v1/webhooks/{id}" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

Response 200

```json
{
  "webhook": {
    "createdAt": "2026-01-15T09:30:00Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "delivery": {
      "directoryIds": [
        "string"
      ],
      "linkIds": [
        "string"
      ],
      "moments": [
        "KIND_ENTRY"
      ],
      "stepIds": [
        "string"
      ],
      "tagIds": [
        "string"
      ],
      "targetsGone": false,
      "visitorAttributeKeys": [
        "string"
      ],
      "visitorData": "INTEGRATION_VISITOR_DATA_NONE"
    },
    "endpointUrl": "https://api.example.com/webhooks/linkbreakers",
    "failureCount": 0,
    "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "lastDeliveredAt": "2026-01-15T09:30:00Z",
    "lastSentAt": "2026-01-15T09:30:00Z",
    "linkId": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "name": "Production Event Notifications",
    "source": "WEBHOOK_SOURCE_LINKBREAKERS",
    "status": "WEBHOOK_STATUS_ACTIVE",
    "successCount": 0,
    "triggers": [
      "KIND_ENTRY",
      "KIND_EXIT"
    ],
    "updatedAt": "2026-01-15T09:30:00Z",
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}
```

### Parameters

`Idempotency-Key` string 

header

A unique value per request, such as a UUID, that makes retrying it safe: a retry with the same key and body returns the first response instead of acting twice.

### Request body

`delivery` object

Where, when and what it sends. When set, it takes over from triggers and linkId. Leave it out to use those, or send at every moment on every link.

7 child attributes

`directoryIds` array of string

Where: directories it applies to, with every directory below them.

`linkIds` array of string

Where: links it applies to. All three lists empty means every link.

`moments` array of enum

When: the moments of a visit it sends at. Ignored when stepIds is set.

`stepIds` array of string

When: send only when a visit reaches one of these workflow steps.

`tagIds` array of string

Where: tags it applies to.

`visitorAttributeKeys` array of string

What: with SELECTED, the attribute keys sent, such as "$email" or "rating".

`visitorData` enum

How much of what is known about the visitor an integration sends.

Allowed values

* `INTEGRATION_VISITOR_DATA_NONE` Only the visit: the link, the step, the device and the place.
* `INTEGRATION_VISITOR_DATA_ALL` The visit, and every attribute known about the visitor.
* `INTEGRATION_VISITOR_DATA_SELECTED` The visit, and only the attributes named in visitorAttributeKeys.

`endpointUrl` string 

Required

The URL endpoint that will receive webhook POST requests

`linkId` string

Filter webhook notifications by a specific link ID. Only events from this link will trigger webhook notifications. If empty, all links in the workspace will trigger notifications.

`name` string 

Required

The name of the webhook

`source` enum

Source of the webhook - indicates creation method (optional, defaults to LINKBREAKERS for manual dashboard creation)

Allowed values

* `WEBHOOK_SOURCE_LINKBREAKERS` Webhook created manually through the Linkbreakers dashboard/platform
* `WEBHOOK_SOURCE_MAKE` Webhook created automatically via Make.com integration
* `WEBHOOK_SOURCE_ZAPIER` Webhook created automatically via Zapier integration
* `WEBHOOK_SOURCE_N8N` Webhook created automatically by the Linkbreakers node in n8n
* `WEBHOOK_SOURCE_INTEGRATELY` Webhook created automatically via Integrately
* `WEBHOOK_SOURCE_UNSPECIFIED` Webhook source not specified (defaults to LINKBREAKERS)

`triggers` array of enum

Filter webhook notifications by workflow step kinds. Only workflow steps matching these kinds will trigger webhook notifications: KIND\_ENTRY sends visit.entered, KIND\_INTERACTION visit.interacted, KIND\_CONDITION visit.routed and KIND\_EXIT visit.exited. If empty, all workflow step kinds will trigger notifications.

### Response

200

`webhook` object

The created webhook

Fields: [The webhook object](#webhooks-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X POST "https://api.linkbreakers.com/v1/webhooks" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
  "delivery": {
    "directoryIds": [
      "string"
    ],
    "linkIds": [
      "string"
    ],
    "moments": [
      "KIND_ENTRY"
    ],
    "stepIds": [
      "string"
    ],
    "tagIds": [
      "string"
    ],
    "visitorAttributeKeys": [
      "string"
    ],
    "visitorData": "INTEGRATION_VISITOR_DATA_NONE"
  },
  "endpointUrl": "https://example.com",
  "linkId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
  "name": "string",
  "source": "WEBHOOK_SOURCE_LINKBREAKERS",
  "triggers": [
    "KIND_ENTRY"
  ]
}'
```

Response 200

```json
{
  "webhook": {
    "createdAt": "2026-01-15T09:30:00Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "delivery": {
      "directoryIds": [
        "string"
      ],
      "linkIds": [
        "string"
      ],
      "moments": [
        "KIND_ENTRY"
      ],
      "stepIds": [
        "string"
      ],
      "tagIds": [
        "string"
      ],
      "targetsGone": false,
      "visitorAttributeKeys": [
        "string"
      ],
      "visitorData": "INTEGRATION_VISITOR_DATA_NONE"
    },
    "endpointUrl": "https://api.example.com/webhooks/linkbreakers",
    "failureCount": 0,
    "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "lastDeliveredAt": "2026-01-15T09:30:00Z",
    "lastSentAt": "2026-01-15T09:30:00Z",
    "linkId": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "name": "Production Event Notifications",
    "source": "WEBHOOK_SOURCE_LINKBREAKERS",
    "status": "WEBHOOK_STATUS_ACTIVE",
    "successCount": 0,
    "triggers": [
      "KIND_ENTRY",
      "KIND_EXIT"
    ],
    "updatedAt": "2026-01-15T09:30:00Z",
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}
```

### Parameters

`id` string 

path

Required

Identifier of the webhook to update (UUID)

`Idempotency-Key` string 

header

A unique value per request, such as a UUID, that makes retrying it safe: a retry with the same key and body returns the first response instead of acting twice.

### Request body

`delivery` object

Where, when and what it sends. When set, it replaces the whole setting and takes over from triggers and linkId. Leave it out to keep the current one.

7 child attributes

`directoryIds` array of string

Where: directories it applies to, with every directory below them.

`linkIds` array of string

Where: links it applies to. All three lists empty means every link.

`moments` array of enum

When: the moments of a visit it sends at. Ignored when stepIds is set.

`stepIds` array of string

When: send only when a visit reaches one of these workflow steps.

`tagIds` array of string

Where: tags it applies to.

`visitorAttributeKeys` array of string

What: with SELECTED, the attribute keys sent, such as "$email" or "rating".

`visitorData` enum

How much of what is known about the visitor an integration sends.

Allowed values

* `INTEGRATION_VISITOR_DATA_NONE` Only the visit: the link, the step, the device and the place.
* `INTEGRATION_VISITOR_DATA_ALL` The visit, and every attribute known about the visitor.
* `INTEGRATION_VISITOR_DATA_SELECTED` The visit, and only the attributes named in visitorAttributeKeys.

`endpointUrl` string

The URL endpoint that will receive webhook POST requests

`linkId` string

Filter webhook notifications by a specific link ID. Only events from this link will trigger webhook notifications. If empty, all links in the workspace will trigger notifications.

`name` string

The name of the webhook

`source` enum

Source of the webhook - indicates whether created manually or via integration

Allowed values

* `WEBHOOK_SOURCE_LINKBREAKERS` Webhook created manually through the Linkbreakers dashboard/platform
* `WEBHOOK_SOURCE_MAKE` Webhook created automatically via Make.com integration
* `WEBHOOK_SOURCE_ZAPIER` Webhook created automatically via Zapier integration
* `WEBHOOK_SOURCE_N8N` Webhook created automatically by the Linkbreakers node in n8n
* `WEBHOOK_SOURCE_INTEGRATELY` Webhook created automatically via Integrately
* `WEBHOOK_SOURCE_UNSPECIFIED` Webhook source not specified (defaults to LINKBREAKERS)

`status` enum

Current status of the webhook

Allowed values

* `WEBHOOK_STATUS_ACTIVE` Webhook is active and receiving events
* `WEBHOOK_STATUS_DISABLED` Webhook is disabled due to repeated failures
* `WEBHOOK_STATUS_PAUSED` Webhook is paused by user action

`triggers` array of enum

Filter webhook notifications by workflow step kinds. Only workflow steps matching these kinds will trigger webhook notifications: KIND\_ENTRY sends visit.entered, KIND\_INTERACTION visit.interacted, KIND\_CONDITION visit.routed and KIND\_EXIT visit.exited. If empty, all workflow step kinds will trigger notifications.

### Response

200

`webhook` object

The updated webhook

Fields: [The webhook object](#webhooks-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X PATCH "https://api.linkbreakers.com/v1/webhooks/{id}" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
  "delivery": {
    "directoryIds": [
      "string"
    ],
    "linkIds": [
      "string"
    ],
    "moments": [
      "KIND_ENTRY"
    ],
    "stepIds": [
      "string"
    ],
    "tagIds": [
      "string"
    ],
    "visitorAttributeKeys": [
      "string"
    ],
    "visitorData": "INTEGRATION_VISITOR_DATA_NONE"
  },
  "endpointUrl": "https://example.com",
  "linkId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
  "name": "string",
  "source": "WEBHOOK_SOURCE_LINKBREAKERS",
  "status": "WEBHOOK_STATUS_ACTIVE",
  "triggers": [
    "KIND_ENTRY"
  ]
}'
```

Response 200

```json
{
  "webhook": {
    "createdAt": "2026-01-15T09:30:00Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "delivery": {
      "directoryIds": [
        "string"
      ],
      "linkIds": [
        "string"
      ],
      "moments": [
        "KIND_ENTRY"
      ],
      "stepIds": [
        "string"
      ],
      "tagIds": [
        "string"
      ],
      "targetsGone": false,
      "visitorAttributeKeys": [
        "string"
      ],
      "visitorData": "INTEGRATION_VISITOR_DATA_NONE"
    },
    "endpointUrl": "https://api.example.com/webhooks/linkbreakers",
    "failureCount": 0,
    "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "lastDeliveredAt": "2026-01-15T09:30:00Z",
    "lastSentAt": "2026-01-15T09:30:00Z",
    "linkId": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "name": "Production Event Notifications",
    "source": "WEBHOOK_SOURCE_LINKBREAKERS",
    "status": "WEBHOOK_STATUS_ACTIVE",
    "successCount": 0,
    "triggers": [
      "KIND_ENTRY",
      "KIND_EXIT"
    ],
    "updatedAt": "2026-01-15T09:30:00Z",
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}
```

### Parameters

`id` string 

path

Required

Identifier of the webhook to delete (UUID)

### Response

200

An empty JSON object.

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X DELETE "https://api.linkbreakers.com/v1/webhooks/{id}" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

---

Source: https://linkbreakers.com/help/api/webhooks
