Skip to main content
GET
/
v2
/
webhooks
List Webhooks
curl --request GET \
  --url https://api.example.com/v2/webhooks \
  --header 'x-api-key: <x-api-key>'
{
  "success": true,
  "data": {
    "items": [
      {
        "webhook_id": "6789abcdef0123456789abcd",
        "account_id": "69c127c37cae0494dd827286",
        "platform": "linkedin",
        "url": "https://your-server.com/webhook",
        "events": ["all"],
        "is_active": true,
        "created_at": "2025-01-15T10:30:00.000000",
        "updated_at": "2025-01-15T10:30:00.000000"
      }
    ],
    "total": 1,
    "limit": 1,
    "offset": 0
  },
  "metadata": {
    "action": "list_webhooks",
    "credits_consumed": 0,
    "timestamp": "2025-01-15T10:30:00.000000"
  }
}
Retrieve all webhook configurations associated with your API key.

Header Parameters

x-api-key
string
required
Your API key

Response

success
boolean
Whether the request was successful
data
object
{
  "success": true,
  "data": {
    "items": [
      {
        "webhook_id": "6789abcdef0123456789abcd",
        "account_id": "69c127c37cae0494dd827286",
        "platform": "linkedin",
        "url": "https://your-server.com/webhook",
        "events": ["all"],
        "is_active": true,
        "created_at": "2025-01-15T10:30:00.000000",
        "updated_at": "2025-01-15T10:30:00.000000"
      }
    ],
    "total": 1,
    "limit": 1,
    "offset": 0
  },
  "metadata": {
    "action": "list_webhooks",
    "credits_consumed": 0,
    "timestamp": "2025-01-15T10:30:00.000000"
  }
}