v11

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0112893437.0 KB

Webhooks

Create webhook

post/webhooks

Request body

urlstring uri required

HTTPS URL

eventTypesEventType[] required

Array of event types to subscribe to.

Example request

{
  "url": "https://example.com/webhook",
  "eventTypes": [
    "tweet.new",
    "tweet.reply"
  ]
}

Response

Webhook created

idstring required

urlstring uri required

secretstring required

Plaintext HMAC signing secret returned only at creation.

eventTypesEventType[] required

Array of event types to subscribe to.

createdAtstring date-time required

Example response

{
  "id": "42",
  "url": "https://example.com/webhook",
  "secret": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2",
  "eventTypes": [
    "tweet.new",
    "tweet.reply"
  ],
  "createdAt": "2025-01-15T12:00:00Z"
}