Sign in
Integrations

Update integration

patch/integrations/{id}

Path parameters

idstring required

Resource ID (stringified bigint)

Request body

namestring
eventTypesEventType[]

Array of event types to subscribe to.

isActiveboolean
silentPushboolean
scopeAllMonitorsboolean
messageTemplateobject

Custom message template (JSON)

filtersobject

Event filter rules (JSON)

Example request

{
  "name": "My Telegram Bot",
  "eventTypes": [
    "tweet.new",
    "follower.gained"
  ],
  "isActive": true,
  "scopeAllMonitors": true,
  "messageTemplate": {},
  "filters": {}
}

Response

Integration updated

idstring required
type'telegram' required
namestring required
configobject required

Integration config — shape varies by type (JSON)

eventTypesEventType[] required

Array of event types to subscribe to.

isActiveboolean required
silentPushboolean
scopeAllMonitorsboolean
messageTemplatestring
filtersobject

Event filter rules (JSON)

createdAtstring date-time required

Example response

{
  "id": "42",
  "type": "telegram",
  "name": "My Telegram Bot",
  "config": {
    "chatId": "-1001234567890"
  },
  "eventTypes": [
    "tweet.new",
    "follower.gained"
  ],
  "isActive": true,
  "scopeAllMonitors": true,
  "messageTemplate": "New event: {{event.type}}",
  "filters": {
    "minFollowers": 100
  },
  "createdAt": "2025-01-15T12:00:00Z"
}

Changes