Skip to main content
POST
/
integrations
Create integration
curl --request POST \
  --url https://xquik.com/api/v1/integrations \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "type": "<string>",
  "name": "<string>",
  "config": {
    "config.chatId": "<string>"
  },
  "eventTypes": [
    "<string>"
  ]
}
'
Free — does not consume credits
curl -X POST https://xquik.com/api/v1/integrations \
  -H "x-api-key: xq_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "telegram",
    "name": "My Telegram Bot",
    "config": { "chatId": "-1001234567890" },
    "eventTypes": ["tweet.new", "tweet.reply"]
  }' | jq

​
Headers

​
x-api-key
string
required
Your API key. Session cookie authentication is also supported. Generate a key from the dashboard.
​
Content-Type
string
required
Must be application/json.

​
Body

​
type
string
required
Integration type. Currently supported: "telegram".
​
name
string
required
A human-readable name for the integration.
​
config
object
required
Configuration object for the integration type.
​
eventTypes
string[]
required
Array of event types to subscribe to. At least 1 required. Valid types: tweet.new, tweet.quote, tweet.reply, tweet.retweet, draw.completed, extraction.completed, extraction.failed.

​
Response

​
id
string
Unique integration ID.
​
type
string
Integration type.
​
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: List Integrations to see all integrations, or Test Integration to send a test notification.