Register a webhook

POST 
/v1/webhooks/register

Register a new webhook endpoint to receive notifications.

Request

application/json

Body

required

url string

The URL of the webhook endpoint to register.

events string[]

The list of events to subscribe to.

Responses

201

Webhook registered successfully.

application/json

Schema

Schema

message string
apiSecretKey string

Example (from schema)

{
  "message": "string",
  "apiSecretKey": "string"
}

400

One or more parameter values are invalid. Please check and retry.

application/json

Schema

Schema

errorId string

Links error message to a specific event in the system.

code stringrequired

The code for the error that has occurred.

text stringrequired

The text for the error that has occurred.

parameter_name string

An optional parameter name related to the error. Usually present for input validation errors.

parameter_value object

An optional parameter value related to the error. Set to input value of named parameter.

Example (from schema)

{
  "errorId": "string",
  "code": "string",
  "text": "string",
  "parameter_name": "string",
  "parameter_value": {}
}

401

Authentication token is required for this action that was not provided, expired or invalid.

application/json

Schema

Schema

errorId string

Links error message to a specific event in the system.

code stringrequired

The code for the error that has occurred.

text stringrequired

The text for the error that has occurred.

parameter_name string

An optional parameter name related to the error. Usually present for input validation errors.

parameter_value object

An optional parameter value related to the error. Set to input value of named parameter.

Example (from schema)

{
  "errorId": "string",
  "code": "string",
  "text": "string",
  "parameter_name": "string",
  "parameter_value": {}
}

404

The requested endpoint or entity does not exist.

application/json

Schema

Schema

errorId string

Links error message to a specific event in the system.

code stringrequired

The code for the error that has occurred.

text stringrequired

The text for the error that has occurred.

parameter_name string

An optional parameter name related to the error. Usually present for input validation errors.

parameter_value object

An optional parameter value related to the error. Set to input value of named parameter.

Example (from schema)

{
  "errorId": "string",
  "code": "string",
  "text": "string",
  "parameter_name": "string",
  "parameter_value": {}
}

500

Internal server error.

application/json

Schema

Schema

errorId string

Links error message to a specific event in the system.

code stringrequired

The code for the error that has occurred.

text stringrequired

The text for the error that has occurred.

parameter_name string

An optional parameter name related to the error. Usually present for input validation errors.

parameter_value object

An optional parameter value related to the error. Set to input value of named parameter.

Example (from schema)

{
  "errorId": "string",
  "code": "string",
  "text": "string",
  "parameter_name": "string",
  "parameter_value": {}
}

503

The server is currently unavailable due to non-working hours. Please try again later.

application/json

Schema

Schema

errorId string

Links error message to a specific event in the system.

code stringrequired

The code for the error that has occurred.

text stringrequired

The text for the error that has occurred.

parameter_name string

An optional parameter name related to the error. Usually present for input validation errors.

parameter_value object

An optional parameter value related to the error. Set to input value of named parameter.

Example (from schema)

{
  "errorId": "string",
  "code": "string",
  "text": "string",
  "parameter_name": "string",
  "parameter_value": {}
}

Loading...