Skip to main content
POST
Register an HTTPS webhook endpoint

TypeScript

Authorizations

Authorization
string
header
required

Revise API key from https://revise.io/console/api-keys. Send Authorization: Bearer .

Headers

Idempotency-Key
string
required
Required string length: 1 - 128

Body

application/json
url
string<uri>
required
Example:

"https://app.example.com/hooks/revise"

events
enum<string>[]
required
Required array length: 1 - 7 elements
Available options:
prompt.completed,
prompt.failed,
prompt.cancelled,
prompt.paused,
conversion.completed,
conversion.failed,
conversion.cancelled

Response

Success

id
string
required
Example:

"wh_21ff52db-63f9-4a1c-a1ab-8d1a9f11c201"

url
string<uri>
required
Example:

"https://example.com/webhooks/revise"

events
enum<string>[]
required
Required array length: 1 - 7 elements
Available options:
prompt.completed,
prompt.failed,
prompt.cancelled,
prompt.paused,
conversion.completed,
conversion.failed,
conversion.cancelled
Example:
created_at
string<date-time>
required
Example:

"2026-09-08T12:00:00Z"

deleted_at
string<date-time> | null
required
Example:

null

signing_secret
string

Returned only on creation and its idempotent replay. Store securely.

Example:

"whsec_AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8="