Skip to main content
POST
workflow.webhook.signed-call

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
url
string<uri>
required

Public receiver URL; checked again when connecting.

Maximum string length: 2048
payload
object
required

JSON object to sign and deliver exactly once.

signaturePolicyRef
string
required

The ref returned by workflow.webhook.signing-policy.create.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
eventId
string
required

Stable event id for this policy. Reuse only for the identical URL and payload.

Pattern: ^[A-Za-z0-9_.-]{1,128}$

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.