Skip to main content
POST
Rotate a webhook signing secret

Authorizations

Authorization
string
header
default:ir_test_REPLACE_WITH_YOUR_TEST_KEY
required

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

Path Parameters

id
string<uuid>
required

Body

application/json

Rotation options

overlapSeconds
integer
default:86400

How long deliveries stay signed with the old secret too (0 to 604800 seconds, default 1 day). 0 drops it at once.

Required range: 0 <= x <= 604800
Example:

86400

Response

The endpoint with its new 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
previousSecretExpiresAt
string<date-time> | null
required

Until this time deliveries are also signed with the secret replaced by the last rotation; null when there is none

url
string
required
Example:

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

secret
string
required

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

Example:

"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD"