Stream Webhooks

Create webhook

Create a new webhook endpoint for a stream monitor. Webhooks receive HMAC-SHA256 signed POST requests when new tweets are detected.

post/v1/twitter/stream/webhooks

Request

Base URL
https://scrapebadger.com
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/scrapebadger/apis/scrapebadger-account-api/docs/v1/twitter/stream/webhooks/post.ts
A function with typed inputs. Its response is checked against the schema.

monitor_idstring required

The ID of the stream monitor to attach this webhook to.

urlstring required

HTTPS URL to receive webhook deliveries. Must use HTTPS.

secretstring nullable

Secret used to sign webhook payloads with HMAC-SHA256.

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

Webhook created successfully.

idstring required

Unique webhook identifier.

monitor_idstring required

ID of the associated stream monitor.

urlstring required

HTTPS URL of the webhook endpoint.

secretstring nullable

Webhook secret for HMAC-SHA256 signing. Only returned once on creation.

created_atstring date-time required

Timestamp when the webhook was created.

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