Skip to main content
POST
/
notifications
/
v1
/
subscriptions
Create a new webhook subscription.
curl --request POST \
  --url https://sandbox-api.sandbox.lemmax.com/notifications/v1/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "My webhooks",
  "endpoint": "https://example.org/webhooks"
}
'
{
  "data": {
    "description": "My webhooks",
    "endpoint": "https://example.org/webhooks",
    "id": "f89eccda-f284-4e30-984f-2f6620238cd1",
    "signing_key": "f89eccda-f284-4e30-984f-2f662023abc2",
    "status": "enabled",
    "version": "1"
  }
}

Authorizations

​
Authorization
string
header
required

access_token returned by the /auth/v1/oauth2/tokens API call.

Body

application/json

Subscription attributes.

Create a webhook subscription.

​
description
string
required

The description for the webhook subscription.

Maximum string length: 200
Example:

"My webhooks"

​
endpoint
string
required

The endpoint of the webhook subscription.

Maximum string length: 2500
Example:

"https://example.org/webhooks"

Response

Subscription created.

Create a webhook subscription response.

​
data
object