Monitoring

Create Webhook

Register your HTTPS endpoint to receive signed monitor events. The signing secret is returned exactly once in this response; store it immediately, it cannot be retrieved again. Cost: Free per call.

post/webhook

Request

  • Base URL: https://api.twitterapis.com/twitter
  • URL: https://api.twitterapis.com/twitter/webhook
  • Auth: HTTP bearer

Request body

urlstring required

Your https delivery endpoint. Private, loopback, link-local, and metadata IPs are refused, re-checked at every delivery, not just at creation.

Example request

{
  "url": "https://example.com/webhooks/twitterapis"
}

Response

Register a URL to receive monitor events.

idstring

The new webhook's id.

urlstring

The registered delivery URL.

statusstring

"active" (delivers) or "disabled" (a 410 Gone response from your endpoint sets this; re-register to reactivate).

secretstring

The HMAC signing secret, shown ONLY in this response. Use it to verify the X-TwitterAPIs-Signature header on every delivery.

created_atstring

ISO 8601 creation timestamp.

Changes

No recorded changes to this operation across all 1 revision of this API.