Get a webhook endpoint - InkRelay

Get a webhook endpoint

curl --request GET \
  --url https://api.printeasy.adfinite.com/v1/webhooks/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.printeasy.adfinite.com/v1/webhooks/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "disabledReason": "<string>",
  "enabled": true,
  "events": [
    "printjob.done"
  ],
  "failingSince": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mode": "live",
  "url": "https://example.com/printeasy/webhooks"
}

{
  "error": {
    "code": "not_found",
    "message": "Printer not found",
    "request_id": "4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Printer not found",
    "request_id": "4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Printer not found",
    "request_id": "4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Printer not found",
    "request_id": "4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Printer not found",
    "request_id": "4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a"
  }
}

GET

/

v1

/

webhooks

/

{id}

Get a webhook endpoint

curl --request GET \
  --url https://api.printeasy.adfinite.com/v1/webhooks/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.printeasy.adfinite.com/v1/webhooks/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "disabledReason": "<string>",
  "enabled": true,
  "events": [
    "printjob.done"
  ],
  "failingSince": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mode": "live",
  "url": "https://example.com/printeasy/webhooks"
}

{
  "error": {
    "code": "not_found",
    "message": "Printer not found",
    "request_id": "4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Printer not found",
    "request_id": "4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Printer not found",
    "request_id": "4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Printer not found",
    "request_id": "4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Printer not found",
    "request_id": "4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a"
  }
}

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.

Path Parameters

id

string<uuid>

required

Response

The endpoint

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"