API Keys Webhook

Subscribe

Add webhook endpoint to an API key

post

Header parameters

api-keystringRequired

Body

application/json

urlstringRequired

Responses

201Success

application/json

webhookIdstringRequired

400Error

500Error

post

/v1/api-keys/webhook/subscribe

HTTPcURLJavaScriptPython

POST /v1/api-keys/webhook/subscribe HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "url": "text",
  "events": [
    "test"
  ]
}

{
  "webhookId": "text"
}

Unsubscribe

Remove webhook endpoint from an API key

delete

Path parameters

apiWebhookIdstringRequired

Header parameters

api-keystringRequired

Responses

201Success

No content

400Error

500Error

delete

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

HTTPcURLJavaScriptPython

DELETE /v1/api-keys/webhook/unsubscribe/{apiWebhookId} HTTP/1.1
api-key: text
Accept: */*

No content