Webhooks

Changed on

Registers an endpoint for signed event deliveries.

post/api/v1/webhooks

Request

  • Base URL: https://xquik.com
  • URL: https://xquik.com/api/v1/webhooks
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Request body

urlstring uri required

HTTPS URL. A Discord channel webhook or a Slack incoming webhook URL gets chat messages. The events of 1 post come as 1 alert, & alerts that wait together as 1 digest. A busy channel gets 5 quick messages, then 1 every 30 s. To deliver to Telegram, use POST /webhooks/telegram instead.

eventTypesEventType[] required

Array of event types to subscribe to.

Example request

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

Response

Webhook created

ignoredFieldsIgnoredFields (unresolved $ref)
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

Changes

  • 45942c75fdc2Revision changes
    • warning

      added the new topup_in_progress enum value to the ///// response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status