Webhooks

Get a webhook subscription by ID

Retrieve details for a specific webhook subscription including its target URL, subscribed events, and current status.

get/v3/webhook-subscriptions/{subscriptionId}

Request

  • Base URL: https://api.linqapp.com/api/partner
  • URL: https://api.linqapp.com/api/partner/v3/webhook-subscriptions/{subscriptionId}
  • Auth: HTTP bearer

Path parameters

subscriptionIdstring required
Example:b2c3d4e5-f6a7-8901-bcde-f23456789012

Unique identifier of the webhook subscription

Response

Webhook subscription found and returned successfully

idstring required

Unique identifier for the webhook subscription

target_urlstring uri required

URL where webhook events will be sent

subscribed_eventsWebhookEventType[] required

List of event types this subscription receives

phone_numbersstring[] nullable

Phone numbers this subscription filters for. If null or empty, events from all phone numbers are delivered.

routing_key_headerstring nullable

Header carrying the routing token. Null disables delivery affinity.

routing_id_headerstring nullable

Header carrying the chat id. Defaults to Linq-Chat-Id when affinity is on.

is_activeboolean required

Whether this subscription is currently active

created_atstring date-time required

When the subscription was created

updated_atstring date-time required

When the subscription was last updated

Example response

{
  "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
  "target_url": "https://webhooks.example.com/linq/events",
  "subscribed_events": [
    "message.sent",
    "message.delivered",
    "message.read"
  ],
  "routing_key_header": "X-Route-Token",
  "routing_id_header": "X-Chat-Id",
  "is_active": true,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.