Webhooks API Reference

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-11T02:15:53.665Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "endpointUrl": "https://api.example.com/webhooks/linkbreakers",
      "failureCount": "string",
      "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
      "lastDeliveredAt": "2025-10-11T02:15:53.665Z",
      "lastSentAt": "2025-10-11T02:15:53.665Z",
      "name": "Production Event Notifications",
      "status": "WEBHOOK_STATUS_ACTIVE",
      "successCount": "string",
      "updatedAt": "2025-10-11T02:15:53.665Z",
      "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-11T02:15:53.666Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "endpointUrl": "https://api.example.com/webhooks/linkbreakers",
    "failureCount": "string",
    "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "lastDeliveredAt": "2025-10-11T02:15:53.666Z",
    "lastSentAt": "2025-10-11T02:15:53.666Z",
    "name": "Production Event Notifications",
    "status": "WEBHOOK_STATUS_ACTIVE",
    "successCount": "string",
    "updatedAt": "2025-10-11T02:15:53.666Z",
    "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

name

stringRequired

The name of the webhook

#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","name":"string"}'

Sample payload (application/json)

{
  "endpointUrl": "https://example.com",
  "name": "string"
}

Typical response

{
  "webhook": {
    "createdAt": "2025-10-11T02:15:53.666Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "endpointUrl": "https://api.example.com/webhooks/linkbreakers",
    "failureCount": "string",
    "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "lastDeliveredAt": "2025-10-11T02:15:53.666Z",
    "lastSentAt": "2025-10-11T02:15:53.666Z",
    "name": "Production Event Notifications",
    "status": "WEBHOOK_STATUS_ACTIVE",
    "successCount": "string",
    "updatedAt": "2025-10-11T02:15:53.666Z",
    "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

name

string

The name of the webhook

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

#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","name":"string","status":"WEBHOOK_STATUS_UNSPECIFIED"}'

Sample payload (application/json)

{
  "endpointUrl": "https://example.com",
  "name": "string",
  "status": "WEBHOOK_STATUS_UNSPECIFIED"
}

Typical response

{
  "webhook": {
    "createdAt": "2025-10-11T02:15:53.666Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "endpointUrl": "https://api.example.com/webhooks/linkbreakers",
    "failureCount": "string",
    "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "lastDeliveredAt": "2025-10-11T02:15:53.666Z",
    "lastSentAt": "2025-10-11T02:15:53.666Z",
    "name": "Production Event Notifications",
    "status": "WEBHOOK_STATUS_ACTIVE",
    "successCount": "string",
    "updatedAt": "2025-10-11T02:15:53.666Z",
    "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.