Webhooks API Reference

#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)

The timestamp when the webhook was created

createdBy

string

The member who created the webhook (UUID)

endpointUrl

string

The URL endpoint that will receive webhook POST requests

failureCount

string (int64)

Count of failed webhook deliveries

string

The unique identifier of the webhook (UUID)

lastDeliveredAt

string (date-time)

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)

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

string (enum)

The source of a webhook - indicates whether the webhook was created manually through the Linkbreakers dashboard or automatically via an integration platform such as Make.com or Zapier

Allowed values

WEBHOOK_SOURCE_UNSPECIFIED

Webhook source not specified (defaults to LINKBREAKERS)

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

status

string (enum)

The status of a webhook

Allowed values

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

successCount

string (int64)

Count of successful webhook deliveries

triggers

array<string (enum)>

Filter webhook notifications by workflow step kinds. Only workflow steps matching these kinds will trigger webhook notifications. If empty, all workflow step kinds will trigger notifications.

updatedAt

string (date-time)

The timestamp when the webhook was last updated

workspaceId

string

The workspace ID the webhook belongs to (UUID)

Learn more

Learn more about webhooks in Linkbreakers

Example object

{
  "createdAt": "2025-10-31T17:28:15.203Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "endpointUrl": "https://api.example.com/webhooks/linkbreakers",
  "failureCount": "string",
  "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
  "lastDeliveredAt": "2025-10-31T17:28:15.203Z",
  "lastSentAt": "2025-10-31T17:28:15.203Z",
  "linkId": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
  "name": "Production Event Notifications",
  "source": "WEBHOOK_SOURCE_LINKBREAKERS",
  "status": "WEBHOOK_STATUS_ACTIVE",
  "successCount": "string",
  "triggers": [
    "KIND_ENTRY",
    "KIND_EXIT"
  ],
  "updatedAt": "2025-10-31T17:28:15.203Z",
  "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
}

GET/v1/webhooksRequires auth

#List webhooks

Enumerate all webhooks for the workspace to manage event integrations.

#Parameters

query parameters

status

stringquery

Filter by webhook status (optional)

Allowed values

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

#Response

200

Everything worked as expected.

webhooks

array<object>

Webhooks scoped to the calling workspace

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/webhooks?status={status}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "webhooks": [
    {
      "createdAt": "2025-10-31T17:28:15.197Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "endpointUrl": "https://api.example.com/webhooks/linkbreakers",
      "failureCount": "string",
      "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
      "lastDeliveredAt": "2025-10-31T17:28:15.197Z",
      "lastSentAt": "2025-10-31T17:28:15.197Z",
      "linkId": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
      "name": "Production Event Notifications",
      "source": "WEBHOOK_SOURCE_LINKBREAKERS",
      "status": "WEBHOOK_STATUS_ACTIVE",
      "successCount": "string",
      "triggers": [
        "KIND_ENTRY",
        "KIND_EXIT"
      ],
      "updatedAt": "2025-10-31T17:28:15.197Z",
      "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
    }
  ]
}

Base URL: https://api.linkbreakers.com

GET/v1/webhooks/{id}Requires auth

#Get a webhook

Retrieve details for a specific webhook endpoint.

#Parameters

path parameters

stringRequiredpath

Identifier of the desired webhook (UUID)

#Response

200

Everything worked as expected.

webhook

object

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

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

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

Typical response

{
  "webhook": {
    "createdAt": "2025-10-31T17:28:15.199Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "endpointUrl": "https://api.example.com/webhooks/linkbreakers",
    "failureCount": "string",
    "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "lastDeliveredAt": "2025-10-31T17:28:15.199Z",
    "lastSentAt": "2025-10-31T17:28:15.199Z",
    "linkId": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "name": "Production Event Notifications",
    "source": "WEBHOOK_SOURCE_LINKBREAKERS",
    "status": "WEBHOOK_STATUS_ACTIVE",
    "successCount": "string",
    "triggers": [
      "KIND_ENTRY",
      "KIND_EXIT"
    ],
    "updatedAt": "2025-10-31T17:28:15.199Z",
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}

Base URL: https://api.linkbreakers.com

POST/v1/webhooksRequires auth

#Create a webhook

Create a new webhook endpoint to receive event notifications when workflow steps complete.

#Parameters

This endpoint does not accept any parameters.

#Request body

endpointUrl

stringRequired

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

stringRequired

The name of the webhook

source

string (enum)

The source of a webhook - indicates whether the webhook was created manually through the Linkbreakers dashboard or automatically via an integration platform such as Make.com or Zapier

Allowed values

WEBHOOK_SOURCE_UNSPECIFIED

Webhook source not specified (defaults to LINKBREAKERS)

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

triggers

array<string (enum)>

Filter webhook notifications by workflow step kinds. Only workflow steps matching these kinds will trigger webhook notifications. If empty, all workflow step kinds will trigger notifications.

#Response

200

Everything worked as expected.

webhook

object

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

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X POST "https://api.linkbreakers.com/v1/webhooks" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"endpointUrl":"https://example.com","linkId":"string","name":"string","source":"WEBHOOK_SOURCE_UNSPECIFIED","triggers":["KIND_UNSPECIFIED"]}'

Sample payload (application/json)

{
  "endpointUrl": "https://example.com",
  "linkId": "string",
  "name": "string",
  "source": "WEBHOOK_SOURCE_UNSPECIFIED",
  "triggers": [
    "KIND_UNSPECIFIED"
  ]
}

Typical response

{
  "webhook": {
    "createdAt": "2025-10-31T17:28:15.198Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "endpointUrl": "https://api.example.com/webhooks/linkbreakers",
    "failureCount": "string",
    "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "lastDeliveredAt": "2025-10-31T17:28:15.198Z",
    "lastSentAt": "2025-10-31T17:28:15.198Z",
    "linkId": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "name": "Production Event Notifications",
    "source": "WEBHOOK_SOURCE_LINKBREAKERS",
    "status": "WEBHOOK_STATUS_ACTIVE",
    "successCount": "string",
    "triggers": [
      "KIND_ENTRY",
      "KIND_EXIT"
    ],
    "updatedAt": "2025-10-31T17:28:15.198Z",
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}

Base URL: https://api.linkbreakers.com

PATCH/v1/webhooks/{id}Requires auth

#Update a webhook

Modify an existing webhook endpoint configuration.

#Parameters

path parameters

stringRequiredpath

Identifier of the webhook to update (UUID)

#Request body

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

string (enum)

The source of a webhook - indicates whether the webhook was created manually through the Linkbreakers dashboard or automatically via an integration platform such as Make.com or Zapier

Allowed values

WEBHOOK_SOURCE_UNSPECIFIED

Webhook source not specified (defaults to LINKBREAKERS)

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

status

string (enum)

The status of a webhook

Allowed values

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

triggers

array<string (enum)>

Filter webhook notifications by workflow step kinds. Only workflow steps matching these kinds will trigger webhook notifications. If empty, all workflow step kinds will trigger notifications.

#Response

200

Everything worked as expected.

webhook

object

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

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X PATCH "https://api.linkbreakers.com/v1/webhooks/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"endpointUrl":"https://example.com","linkId":"string","name":"string","source":"WEBHOOK_SOURCE_UNSPECIFIED","status":"WEBHOOK_STATUS_UNSPECIFIED","triggers":["KIND_UNSPECIFIED"]}'

Sample payload (application/json)

{
  "endpointUrl": "https://example.com",
  "linkId": "string",
  "name": "string",
  "source": "WEBHOOK_SOURCE_UNSPECIFIED",
  "status": "WEBHOOK_STATUS_UNSPECIFIED",
  "triggers": [
    "KIND_UNSPECIFIED"
  ]
}

Typical response

{
  "webhook": {
    "createdAt": "2025-10-31T17:28:15.200Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "endpointUrl": "https://api.example.com/webhooks/linkbreakers",
    "failureCount": "string",
    "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "lastDeliveredAt": "2025-10-31T17:28:15.200Z",
    "lastSentAt": "2025-10-31T17:28:15.200Z",
    "linkId": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "name": "Production Event Notifications",
    "source": "WEBHOOK_SOURCE_LINKBREAKERS",
    "status": "WEBHOOK_STATUS_ACTIVE",
    "successCount": "string",
    "triggers": [
      "KIND_ENTRY",
      "KIND_EXIT"
    ],
    "updatedAt": "2025-10-31T17:28:15.200Z",
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}

Base URL: https://api.linkbreakers.com

DELETE/v1/webhooks/{id}Requires auth

#Delete a webhook

Remove a webhook endpoint so it no longer receives event notifications.

#Parameters

path parameters

stringRequiredpath

Identifier of the webhook to delete (UUID)

#Response

200

Everything worked as expected.

No structured schema available for this section.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.