Skip to main content
POST
Create webhook endpoint

Authorizations

Authorization
string
header
required

Your organization API key starting with yph_sk_live_…

Body

application/json
url
string<uri>
required

The secure HTTPS target URL to receive event payloads.

events
enum<string>[]
required
Available options:
insta_swap.queued,
insta_swap.completed,
insta_swap.failed,
digital_sample.analysis.completed,
digital_sample.analysis.failed
verify
boolean
default:true

Whether to verify endpoint reachability synchronously.

Response

Created successfully (the signing secret is only returned once in the response)

id
string<uuid>
orgId
string
url
string<uri>
events
string[]
secret
string

HMAC signature secret (only returned once on creation)

active
boolean
createdAt
string<date-time>
updatedAt
string<date-time>