API Keys Webhook

Subscribe

Add webhook endpoint to an API key

post

/v1/api-keys/webhook/subscribe

Header parameters

api-keystringrequired

Body

urlstringrequired

eventsstring · enum[] · default: print.failed,print.completed

Default if null: print.failed, print.completed

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/api-keys/webhook/subscribe' \
  --header 'api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "text",
    "events": [
      "print.failed",
      "print.completed"
    ]
  }'

201

400

500

201

{
  "webhookId": "text"
}

Unsubscribe

Remove webhook endpoint from an API key

delete

/v1/api-keys/webhook/unsubscribe/{apiWebhookId}

Path parameters

apiWebhookIdstringrequired

Header parameters

api-keystringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/v1/api-keys/webhook/unsubscribe/{apiWebhookId}' \
  --header 'api-key: text'

201

400

500

201

No body