Skip to main content
GET
/
integrations
/
{id}
Get integration
curl --request GET \
  --url https://xquik.com/api/v1/integrations/{id} \
  --header 'x-api-key: <x-api-key>'
Free — does not consume credits
curl -X GET https://xquik.com/api/v1/integrations/4 \
  -H "x-api-key: xq_YOUR_KEY_HERE" | jq

Path parameters

id
string
required
The unique integration ID. Returned when you create an integration or list integrations.

Headers

x-api-key
string
required
Your API key. Session cookie authentication is also supported. Generate a key from the dashboard.

Response

id
string
Unique integration ID.
type
string
Integration type (e.g. "telegram").
name
string
Integration name.
config
object
Integration configuration.
eventTypes
string[]
Subscribed event types.
messageTemplate
string
Custom message template for notifications. null if not set.
scopeAllMonitors
boolean
Whether the integration receives events from all monitors.
silentPush
boolean
Whether Telegram notifications are sent silently.
filters
object
Event filtering rules. null if not set.
isActive
boolean
Whether the integration is active.
createdAt
string
ISO 8601 creation timestamp.
updatedAt
string
ISO 8601 timestamp of last update.
{
  "id": "4",
  "type": "telegram",
  "name": "My Telegram Bot",
  "config": { "chatId": "-1001234567890" },
  "eventTypes": ["tweet.new", "tweet.reply"],
  "messageTemplate": null,
  "scopeAllMonitors": true,
  "silentPush": false,
  "filters": null,
  "isActive": true,
  "createdAt": "2026-03-01T09:00:00.000Z",
  "updatedAt": "2026-03-01T09:00:00.000Z"
}
Related: Update Integration to change settings, Test Integration to send a test notification, or List Deliveries to see delivery history.