curl --request POST \
--url https://api.inkrelay.app/v1/webhooks/{id}/ping \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.inkrelay.app/v1/webhooks/{id}/ping', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.inkrelay.app/v1/webhooks/{id}/ping"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"attempt": 123,
"createdAt": "2023-11-07T05:31:56Z",
"deliveredAt": "2023-11-07T05:31:56Z",
"endpointId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"eventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"eventType": "printjob.done",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nextAttemptAt": "2023-11-07T05:31:56Z",
"payload": {},
"responseBodyExcerpt": "<string>",
"responseCode": 123,
"status": "pending"
}{
"error": {
"code": "not_found",
"message": "Printer not found",
"request_id": "4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a",
"upgrade_url": "https://app.inkrelay.app/billing?upgrade=1"
}
}{
"error": {
"code": "not_found",
"message": "Printer not found",
"request_id": "4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a",
"upgrade_url": "https://app.inkrelay.app/billing?upgrade=1"
}
}{
"error": {
"code": "not_found",
"message": "Printer not found",
"request_id": "4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a",
"upgrade_url": "https://app.inkrelay.app/billing?upgrade=1"
}
}{
"error": {
"code": "not_found",
"message": "Printer not found",
"request_id": "4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a",
"upgrade_url": "https://app.inkrelay.app/billing?upgrade=1"
}
}{
"error": {
"code": "not_found",
"message": "Printer not found",
"request_id": "4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a",
"upgrade_url": "https://app.inkrelay.app/billing?upgrade=1"
}
}{
"error": {
"code": "not_found",
"message": "Printer not found",
"request_id": "4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a",
"upgrade_url": "https://app.inkrelay.app/billing?upgrade=1"
}
}Send a test ping
Queues a signed ping delivery to the endpoint, with the usual retries, to check that it receives and verifies webhooks. The body is an envelope of type ping with empty data. Pings are not events: they never appear in GET /v1/events and never count as usage.
curl --request POST \
--url https://api.inkrelay.app/v1/webhooks/{id}/ping \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.inkrelay.app/v1/webhooks/{id}/ping', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.inkrelay.app/v1/webhooks/{id}/ping"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"attempt": 123,
"createdAt": "2023-11-07T05:31:56Z",
"deliveredAt": "2023-11-07T05:31:56Z",
"endpointId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"eventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"eventType": "printjob.done",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nextAttemptAt": "2023-11-07T05:31:56Z",
"payload": {},
"responseBodyExcerpt": "<string>",
"responseCode": 123,
"status": "pending"
}{
"error": {
"code": "not_found",
"message": "Printer not found",
"request_id": "4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a",
"upgrade_url": "https://app.inkrelay.app/billing?upgrade=1"
}
}{
"error": {
"code": "not_found",
"message": "Printer not found",
"request_id": "4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a",
"upgrade_url": "https://app.inkrelay.app/billing?upgrade=1"
}
}{
"error": {
"code": "not_found",
"message": "Printer not found",
"request_id": "4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a",
"upgrade_url": "https://app.inkrelay.app/billing?upgrade=1"
}
}{
"error": {
"code": "not_found",
"message": "Printer not found",
"request_id": "4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a",
"upgrade_url": "https://app.inkrelay.app/billing?upgrade=1"
}
}{
"error": {
"code": "not_found",
"message": "Printer not found",
"request_id": "4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a",
"upgrade_url": "https://app.inkrelay.app/billing?upgrade=1"
}
}{
"error": {
"code": "not_found",
"message": "Printer not found",
"request_id": "4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a",
"upgrade_url": "https://app.inkrelay.app/billing?upgrade=1"
}
}Authorizations
Send Authorization: Bearer <API key>. Use an ir_test_ key in the playground; it only reaches virtual test printers.
Path Parameters
Response
The ping delivery, queued
Sends made so far, 0 before the first
Also sent as the webhook-id header
One of the subscribable event types, or ping for a test delivery from POST /v1/webhooks/{id}/ping
"printjob.done"
The exact envelope sent as the request body
Show child attributes
Show child attributes
First 2,048 characters of the last response body, or the network error
HTTP status of the last attempt; null when it got no response
pending, retrying, succeeded, failed Was this page helpful?