API Keys

Check API Key

Check the validity of current use api key

get
Header parameters
api-keystringRequired
Responses
200Success
application/json
get
GET /v1/api-keys/check HTTP/1.1
Host: 
api-key: text
Accept: */*
{
  "email": "text",
  "name": "text"
}

Create Endpoint Webhook

Add webhook endpoint to an API key

post
Header parameters
api-keystringRequired
Body
urlstringRequired
Responses
201Success
application/json
post
POST /v1/api-keys/webhook/subscribe HTTP/1.1
Host: 
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 32

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

Remove Webhook

Remove webhook endpoint from an API key

delete
Path parameters
apiWebhookIdstringRequired
Header parameters
api-keystringRequired
Responses
201Success
delete
DELETE /v1/api-keys/webhook/unsubscribe/{apiWebhookId} HTTP/1.1
Host: 
api-key: text
Accept: */*

No content

Get Webhook

Get webhook from its ID

get
Path parameters
apiKeyWebhookIdstringRequired
Header parameters
api-keystringRequired
Responses
201Success
get
GET /v1/api-keys/webhook/{apiKeyWebhookId} HTTP/1.1
Host: 
api-key: text
Accept: */*

No content

Last updated

Was this helpful?