List all webhook subscriptions

webhook_subscriptions.list() -> WebhookSubscriptionListResponse

GET/v3/webhook-subscriptions

Retrieve all webhook subscriptions for the authenticated partner. Returns a list of active and inactive subscriptions with their configuration and status.

ReturnsExpand Collapse

class WebhookSubscriptionListResponse: …

subscriptions: List[WebhookSubscription]

List of webhook subscriptions

id: str

Unique identifier for the webhook subscription

created_at: datetime

When the subscription was created

formatdate-time

is_active: bool

Whether this subscription is currently active

subscribed_events: List[WebhookEventType]

List of event types this subscription receives

One of the following:

"message.sent"

"message.received"

"message.read"

"message.delivered"

"message.failed"

"message.edited"

"reaction.added"

"reaction.removed"

"participant.added"

"participant.removed"

"chat.created"

"chat.group_name_updated"

"chat.group_icon_updated"

"chat.group_name_update_failed"

"chat.group_icon_update_failed"

"chat.typing_indicator.started"

"chat.typing_indicator.stopped"

"phone_number.status_updated"

"call.initiated"

"call.ringing"

"call.answered"

"call.ended"

"call.failed"

"call.declined"

"call.no_answer"

target_url: str

URL where webhook events will be sent

formaturi

updated_at: datetime

When the subscription was last updated

formatdate-time

phone_numbers: Optional[List[str]]

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

List all webhook subscriptions

import os
from linq import LinqAPIV3

client = LinqAPIV3(
    api_key=os.environ.get("LINQ_API_V3_API_KEY"),  # This is the default and can be omitted
)
webhook_subscriptions = client.webhook_subscriptions.list()
print(webhook_subscriptions.subscriptions)

{
  "subscriptions": [
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
      "created_at": "2024-01-15T10:30:00Z",
      "is_active": true,
      "subscribed_events": [
        "message.sent",
        "message.delivered",
        "message.read"
      ],
      "target_url": "https://webhooks.example.com/linq/events",
      "updated_at": "2024-01-15T10:30:00Z",
      "phone_numbers": [
        "string"
      ]
    }
  ]
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token"
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error"
  },
  "success": false
}

Returns Examples

{
  "subscriptions": [
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
      "created_at": "2024-01-15T10:30:00Z",
      "is_active": true,
      "subscribed_events": [
        "message.sent",
        "message.delivered",
        "message.read"
      ],
      "target_url": "https://webhooks.example.com/linq/events",
      "updated_at": "2024-01-15T10:30:00Z",
      "phone_numbers": [
        "string"
      ]
    }
  ]
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token"
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error"
  },
  "success": false
}