Webhooks

Create webhook

Register a webhook. Returns the signing secret once — store it immediately, it cannot be retrieved again. Admin role required. Subscribing to response.submitted requires Premium tier or above — Basic-tier keys receive a 402.

post/v1/communities/{communityId}/webhooks

Request

  • Base URL: https://api.subo.ai
  • URL: https://api.subo.ai/v1/communities/{communityId}/webhooks
  • Auth: API key in header X-API-Key

Path parameters

communityIdstring required

Community ID (Discord guild snowflake, serialized as string)

Request body

urlstring uri required

HTTPS endpoint that will receive POST requests. Must be https:// and resolve only to public addresses; loopback, private and link-local addresses are refused with a 400, and re-checked before every delivery.

namestring

Human-readable label for this webhook

eventsstring[] required

Event types to subscribe to

Example request

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

Response

Created webhook with signing_secret (shown once — store immediately)

Changes

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