Create a new webhook subscription

client.WebhookSubscriptions.New(ctx, body) (*WebhookSubscriptionNewResponse, error)

POST/v3/webhook-subscriptions

Create a new webhook subscription to receive events at a target URL. Upon creation, a signing secret is generated for verifying webhook authenticity. Store this secret securely — it cannot be retrieved later.

Phone Number Filtering:

Optionally specify phone_numbers to only receive events for specific lines
If omitted, events from all phone numbers are delivered (default behavior)
Use multiple subscriptions with different phone_numbers to route different lines to different endpoints
Each target_url can only be used once per account. To route different lines to different destinations, use a unique URL per subscription (e.g., append a query parameter: https://example.com/webhook?line=1)

Webhook Delivery:

Events are sent via HTTP POST to the target URL
Each request includes Standard Webhooks headers (webhook-id, webhook-timestamp, webhook-signature) for signature verification
Legacy X-Webhook-* headers are also sent for backwards compatibility (deprecated)
See Verifying Webhook Signatures for verification details
Failed deliveries (5xx, 429, network errors) are retried with exponential backoff for up to 30 minutes
Client errors (4xx except 429) are not retried

ParametersExpand Collapse

body WebhookSubscriptionNewParams

SubscribedEvents param.Field[[]WebhookEventType]

List of event types to subscribe to

const WebhookEventTypeMessageSent WebhookEventType = "message.sent"

const WebhookEventTypeMessageReceived WebhookEventType = "message.received"

const WebhookEventTypeMessageRead WebhookEventType = "message.read"

const WebhookEventTypeMessageDelivered WebhookEventType = "message.delivered"

const WebhookEventTypeMessageFailed WebhookEventType = "message.failed"

const WebhookEventTypeMessageEdited WebhookEventType = "message.edited"

const WebhookEventTypeReactionAdded WebhookEventType = "reaction.added"

const WebhookEventTypeReactionRemoved WebhookEventType = "reaction.removed"

const WebhookEventTypePollReceived WebhookEventType = "poll.received"

const WebhookEventTypePollFailed WebhookEventType = "poll.failed"

const WebhookEventTypePollSent WebhookEventType = "poll.sent"

const WebhookEventTypePollDelivered WebhookEventType = "poll.delivered"

const WebhookEventTypePollRead WebhookEventType = "poll.read"

const WebhookEventTypePollUpdated WebhookEventType = "poll.updated"

const WebhookEventTypePollVoteAdded WebhookEventType = "poll.vote.added"

const WebhookEventTypePollVoteRemoved WebhookEventType = "poll.vote.removed"

const WebhookEventTypePollReactionAdded WebhookEventType = "poll.reaction.added"

const WebhookEventTypeParticipantAdded WebhookEventType = "participant.added"

const WebhookEventTypeParticipantRemoved WebhookEventType = "participant.removed"

const WebhookEventTypeChatCreated WebhookEventType = "chat.created"

const WebhookEventTypeChatGroupNameUpdated WebhookEventType = "chat.group_name_updated"

const WebhookEventTypeChatGroupIconUpdated WebhookEventType = "chat.group_icon_updated"

const WebhookEventTypeChatGroupNameUpdateFailed WebhookEventType = "chat.group_name_update_failed"

const WebhookEventTypeChatGroupIconUpdateFailed WebhookEventType = "chat.group_icon_update_failed"

const WebhookEventTypeChatBackgroundUpdated WebhookEventType = "chat.background_updated"

const WebhookEventTypeChatBackgroundUpdateFailed WebhookEventType = "chat.background_update_failed"

const WebhookEventTypeChatTypingIndicatorStarted WebhookEventType = "chat.typing_indicator.started"

const WebhookEventTypeChatTypingIndicatorStopped WebhookEventType = "chat.typing_indicator.stopped"

const WebhookEventTypePhoneNumberStatusUpdated WebhookEventType = "phone_number.status_updated"

const WebhookEventTypePhoneNumberAssigned WebhookEventType = "phone_number.assigned"

const WebhookEventTypePhoneNumberReleased WebhookEventType = "phone_number.released"

const WebhookEventTypeContactCardReceived WebhookEventType = "contact_card.received"

const WebhookEventTypeCallInitiated WebhookEventType = "call.initiated"

const WebhookEventTypeCallRinging WebhookEventType = "call.ringing"

const WebhookEventTypeCallAnswered WebhookEventType = "call.answered"

const WebhookEventTypeCallEnded WebhookEventType = "call.ended"

const WebhookEventTypeCallFailed WebhookEventType = "call.failed"

const WebhookEventTypeCallDeclined WebhookEventType = "call.declined"

const WebhookEventTypeCallNoAnswer WebhookEventType = "call.no_answer"

const WebhookEventTypeLocationSharingStarted WebhookEventType = "location.sharing.started"

const WebhookEventTypeLocationSharingStopped WebhookEventType = "location.sharing.stopped"

const WebhookEventTypePaymentSucceeded WebhookEventType = "payment.succeeded"

const WebhookEventTypePaymentCanceled WebhookEventType = "payment.canceled"

const WebhookEventTypePaymentExpired WebhookEventType = "payment.expired"

const WebhookEventTypePaymentDeclined WebhookEventType = "payment.declined"

const WebhookEventTypePaymentAuthorized WebhookEventType = "payment.authorized"

const WebhookEventTypeConnectionCreated WebhookEventType = "connection.created"

const WebhookEventTypeConnectionRevoked WebhookEventType = "connection.revoked"

const WebhookEventTypeZeroDayRetentionUpdated WebhookEventType = "zero_day_retention.updated"

const WebhookEventTypePhoneNumberForwardingUpdated WebhookEventType = "phone_number.forwarding_updated"

const WebhookEventTypeEnvironmentLineMoved WebhookEventType = "environment.line_moved"

const WebhookEventTypeContactCardCreated WebhookEventType = "contact_card.created"

const WebhookEventTypeContactCardUpdated WebhookEventType = "contact_card.updated"

const WebhookEventTypeContactCardDeleted WebhookEventType = "contact_card.deleted"

const WebhookEventTypeAPITokenCreated WebhookEventType = "api_token.created"

const WebhookEventTypeAPITokenRenamed WebhookEventType = "api_token.renamed"

const WebhookEventTypeAPITokenExpiryScheduled WebhookEventType = "api_token.expiry_scheduled"

const WebhookEventTypeAPITokenExpired WebhookEventType = "api_token.expired"

const WebhookEventTypeAPITokenActivated WebhookEventType = "api_token.activated"

const WebhookEventTypeAPITokenDeleted WebhookEventType = "api_token.deleted"

const WebhookEventTypeEnvironmentCreated WebhookEventType = "environment.created"

const WebhookEventTypeEnvironmentRenamed WebhookEventType = "environment.renamed"

const WebhookEventTypeEnvironmentDeleted WebhookEventType = "environment.deleted"

const WebhookEventTypeWebhookSubscriptionCreated WebhookEventType = "webhook_subscription.created"

const WebhookEventTypeWebhookSubscriptionDeleted WebhookEventType = "webhook_subscription.deleted"

const WebhookEventTypeWebhookSubscriptionTargetURLChanged WebhookEventType = "webhook_subscription.target_url_changed"

const WebhookEventTypeWebhookSubscriptionEnabled WebhookEventType = "webhook_subscription.enabled"

const WebhookEventTypeWebhookSubscriptionDisabled WebhookEventType = "webhook_subscription.disabled"

const WebhookEventTypeWebhookSubscriptionEventsUpdated WebhookEventType = "webhook_subscription.events.updated"

const WebhookEventTypeWebhookSubscriptionPhoneNumbersUpdated WebhookEventType = "webhook_subscription.phone_numbers.updated"

const WebhookEventTypeWebhookSubscriptionRoutingHeadersSet WebhookEventType = "webhook_subscription.routing_headers_set"

const WebhookEventTypeWebhookSubscriptionRoutingHeadersCleared WebhookEventType = "webhook_subscription.routing_headers_cleared"

const WebhookEventTypeTeamMemberAdded WebhookEventType = "team_member.added"

const WebhookEventTypeTeamMemberSignedIn WebhookEventType = "team_member.signed_in"

const WebhookEventTypeTeamMemberSignedOut WebhookEventType = "team_member.signed_out"

TargetURL param.Field[string]

URL where webhook events will be sent. Must be HTTPS.

formaturi

PhoneNumbers param.Field[[]string]Optional

Optional list of phone numbers to filter events for. Only events originating from these phone numbers will be delivered to this subscription. If omitted or empty, events from all phone numbers are delivered. Phone numbers must be in E.164 format.

RoutingIDHeader param.Field[string]Optional

Name of the header carrying the chat id, used to hash-route before a token is learned. Defaults to Linq-Chat-Id. Ignored without routing_key_header.

RoutingKeyHeader param.Field[string]Optional

Enables delivery affinity. Name of the header carrying an opaque routing token: we send it on each webhook for a chat and read it back from your 2xx response, so your edge can route to the cluster holding that chat. Omit to disable.

ReturnsExpand Collapse

type WebhookSubscriptionNewResponse struct{…}

Response returned when creating a webhook subscription. Includes the signing secret which is only shown once.

ID string

Unique identifier for the webhook subscription

CreatedAt Time

When the subscription was created

formatdate-time

IsActive bool

Whether this subscription is currently active

SigningSecret string

Secret for verifying webhook signatures. Store this securely - it cannot be retrieved again.

SubscribedEvents []WebhookEventType

List of event types this subscription receives

One of the following: