Webhook endpoints

Rotate a webhook endpoint's signing secret

Mints a new signing secret and returns it once. A verb sub-path rather than a field on PATCH — mirroring POST /api/v1/connections/{connectionId}/reverify — because rotation is an ACTION with a once-only result, not a property you can idempotently PUT; that also keeps the show-once secret out of every ordinary update response. IMMEDIATE CUTOVER, no dual-secret window: the worker reads the secret live at delivery time, so signatures switch at once, including retries of deliveries created before the rotation. Deploy the new secret to your receiver promptly.

post/api/v1/webhook-endpoints/{endpointId}/rotate-secret

Request

  • Base URL: https://app.dodomain.io
  • URL: https://app.dodomain.io/api/v1/webhook-endpoints/{endpointId}/rotate-secret
  • Auth: HTTP bearer

Path parameters

endpointIdstring required

The endpoint id from GET /api/v1/webhook-endpoints.

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.

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.