Skip to main content
POST
Create visual-reading webhook or email delivery

Authorizations

Authorization
string
header
required

Customer session token returned by /auth/login. This is distinct from an API key.

Body

application/json
channel
enum<string>
required
Available options:
webhook,
email
destination
string
required
write-only
event_types
enum<string>[]
required
Required array length: 1 - 3 elements
Available options:
visual_reading.completed,
visual_reading.failed,
visual_reading.input_deleted

Response

Subscription; signing_secret is present only for webhook subscriptions.

subscription
object
required