https://api.certo.bio/v1openapi.json

Set the webhook

PUT/v1/webhookscope webhooks:manage

Sets the organisation's endpoint up, or changes its address or switch. https, a public host name, no IP address, no port but 443, no credentials, no fragment; the name must resolve to public addresses at every send. On creation certo makes the signing secret and answers it ONCE. Owners and admins.

Request body

NameTypeRequiredDescription
urlstringYesThe https endpoint certo POSTs signed events to.
enabledbooleanWhether events are sent (default true).

Response fields

status
one of created, saved. created (with the secret) or saved.
url
string. The endpoint.
enabled
boolean. Whether events are sent.
secret
string or null. whsec_...: the signing secret, answered only on creation and never again (rotate makes a new one).
secret_hint
string. The secret's last four characters.

Errors

  • 400 org_webhook.url_invalid
  • 503 org_webhook.unavailable
  • 400 request.unknown_field
  • 409 api.idempotency_mismatch
  • 409 api.idempotency_in_progress
  • 400 api.credential_in_url
  • 401 api.key_invalid
  • 401 api.key_expired
  • 401 api.key_revoked
  • 401 api.key_suspended
  • 403 api.scope_missing
  • 429 api.rate_limited