Skip to main content
POST
Create a webhook endpoint

Authorizations

Authorization
string
header
default:pe_test_REPLACE_WITH_YOUR_TEST_KEY
required

Send Authorization: Bearer <API key>. Use a pe_test_ key in the playground; it only reaches virtual test printers.

Body

application/json

Endpoint to create

events
enum<string>[]
required
Minimum array length: 1
Available options:
printjob.queued,
printjob.sent,
printjob.received,
printjob.printing,
printjob.done,
printjob.error,
printjob.cancelled,
printjob.expired,
computer.online,
computer.offline,
printer.added,
printer.removed,
printer.online,
printer.offline,
printer.updated
Example:
url
string
required
Maximum string length: 2048
Example:

"https://example.com/printeasy/webhooks"

description
string
Maximum string length: 256
Example:

"ERP print status"

Response

The new endpoint with its secret

createdAt
string<date-time>
required
description
string | null
required
disabledReason
string | null
required

Why the endpoint is disabled: by a user, or automatically after 5 days of failures

enabled
boolean
required
events
enum<string>[]
required
Available options:
printjob.queued,
printjob.sent,
printjob.received,
printjob.printing,
printjob.done,
printjob.error,
printjob.cancelled,
printjob.expired,
computer.online,
computer.offline,
printer.added,
printer.removed,
printer.online,
printer.offline,
printer.updated
failingSince
string<date-time> | null
required

Start of the current run of failed deliveries; null while healthy

id
string<uuid>
required
mode
enum<string>
required
Available options:
live,
test
url
string
required
Example:

"https://example.com/printeasy/webhooks"

secret
string
required

Signing secret, returned only by this response. Store it now.

Example:

"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD"