Skip to main content
POST
Add a webhook endpoint

Authorizations

Authorization
string
header
required

Authorization: Bearer mm_live_…. Mint a key at mediamonster.app/keys; every plan includes the API. A test key, mm_test_…, runs every check a live key does and spends nothing: each run finishes at once with a stand-in file, and says livemode: false. A key does only what its scopes allow.

Headers

X-Request-Id
string

Your own id for this request — 8 to 128 letters, digits, ., _, : or -. Used in place of one we mint, and echoed back.

Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{7,127}$
Idempotency-Key
string

Retry this POST safely: the first request with a key runs and its answer is kept for a day; a retry with the same key and the same request gets that answer again, marked Idempotent-Replayed: true, instead of running twice. 1–255 printable characters — a UUID is a good one.

Required string length: 1 - 255

Body

application/json
url
string<uri>
required

https only; private hosts are refused.

description
string
events
enum<string>[]
Available options:
job.completed,
job.failed,
run.completed,
run.failed,
batch.completed
enabled
boolean

Response

The endpoint and its secret.

An address every settled job and run of the account is posted to, signed with its own secret.

id
string<uuid>
url
string<uri>
description
string
events
enum<string>[]

The events it hears. Empty is every event.

Available options:
job.completed,
job.failed,
run.completed,
run.failed,
batch.completed
enabled
boolean
disabled_reason
string | null
previous_secret_expires_at
string<date-time> | null
failing_since
string<date-time> | null
created_at
string<date-time>
updated_at
string<date-time>
secret
string

whsec_…, shown this once.