Skip to main content
POST
Register an endpoint for job events

Authorizations

X-API-Key
string
header
required

API key

Body

application/json
url
string
required

HTTPS URL that receives a signed POST for each event; it must resolve to a public address

Example:

"https://crm.example.com/hooks/parser"

topics
enum<string>[]

Events to receive; empty = every topic except the opt-in job.corrected and email.received, which go only to endpoints that list them

Available options:
job.completed,
job.review_required,
job.failed,
job.corrected,
mailbox.disconnected,
email.received
description
string | null
Maximum string length: 200

Response

Successful Response

id
string
required
url
string
required
topics
enum<string>[]
required
Available options:
job.completed,
job.review_required,
job.failed,
job.corrected,
mailbox.disconnected,
email.received
active
boolean
required
created_at
string<date-time>
required
secret
string
required

Signing secret for X-Parser-Signature. Shown only now (and on rotation); store it

description
string | null
breaker_open_until
string<date-time> | null

Set while five failures in a row pause deliveries to this endpoint