POST  /webhook/register

  • Several subscribers can be subscribed to one account.
  • A subscriber name cannot be repeated within the same account.

Request Headers

Header

Description

X-Auth-Account-Url (required)The base URL of the account, e.g. https://myaccount.ispringlearn.com
X-Auth-Email (required)The login of Account Owner and Account Administrator.
X-Auth-Password (required)

The password of Account Owner and Account Administrator.

ParameterDescription
subscriberName (required)The unique name of the subscriber. It can have up to 255 characters.
callbackUrl (required)The URL to which the subscribed events will be sent. It can have up to 255 characters.
Secret (optional)HMAC request signature. It can have up to 255 characters.

Sample Request

curl --location 'https://api-learn.ispringlearn.com/webhook/register' \
--header 'X-Auth-Account-Url: https://myaccount.ispringlearn.com' \
--header 'X-Auth-Email: email@email.com' \
--header 'X-Auth-Password: password' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
  "subscriberName": "name",
  "callbackUrl": "https://client.service.com/callback-url",
  "secret": "secret"
}'
CODE

Response Codes

Code

Text

Description

200

ОК

The subscriber has been added.

400

Bad Request

A request error.

401

Unauthorized

An authorization error.

403

Permission Denied

The user doesn't have enough permissions.