Webhook endpoints

Register a webhook endpoint

Registers one delivery target and returns its signing secret once. secret (whsec_...) appears in this response and in a rotate response, and in no read surface ever again — store it now. The URL must be https and must not resolve to a localhost/private/link-local address, and an app cannot register the same normalized URL twice: both refusals are 400 invalid_request with the reason in message. A hostname that resolves only to private, reserved, CGNAT or loopback addresses is refused the same way, with details.reason = webhook_url_resolves_private for clients that branch on it (a host that does not resolve yet is accepted). At the plan's endpoint cap it is 402 quota_exceeded.

post/api/v1/webhook-endpoints

Request

  • Base URL: https://app.dodomain.io
  • URL: https://app.dodomain.io/api/v1/webhook-endpoints
  • Auth: HTTP bearer

Headers

DoDomain-Teamstring

The id of the team this call acts on, from GET /api/v1/teams. Needed only when the credential can use more than one team (an OAuth connection granted several); a secret key has exactly one. A team the credential cannot use is refused 404 TEAM_NOT_FOUND — the same answer whether the team exists or not.

Request body

urlstring required

Response

Success.

appIdstring required
createdAtstring date-time required
idstring required
pausedAtstring date-time nullable required
secretstring required
urlstring required

Changes

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