Webhooks

These endpoints configure, retrieve and remove webhooks. See Webhooks for more details.

Get webhook config

The GET /webhook/config endpoint retrieves the webhook configuration.

SecurityBearer or BasicAuth
Responses
200

Successful response

400

The client specified an invalid argument

401

The authorization information is missing or invalid

403

Permission to access this endpoint is denied

404

The requested entity, such as a payment, was not found

429

Too many requests

500

An unexpected or internal server error

501

The operation was not implemented

503

Service is unavailable

504

Gateway has timed out

get/webhook/config
Request samples
Response samples
application/json
{
  • "config": {
    }
}

Set webhook config

The PUT /webhook/config endpoint sets the webhook configuration.

SecurityBearer or BasicAuth
Request
Request Body schema: application/json
required
object (Config)

Specifies the types of webhook currently configured.

Responses
200

Successful response

400

The client specified an invalid argument

401

The authorization information is missing or invalid

403

Permission to access this endpoint is denied

404

The requested entity, such as a payment, was not found

429

Too many requests

500

An unexpected or internal server error

501

The operation was not implemented

503

Service is unavailable

504

Gateway has timed out

put/webhook/config
Request samples
application/json
{
  • "config": {
    }
}
Response samples
application/json
{ }

Delete webhook config

The DELETE /webhook/config endpoint deletes the webhook configuration.

SecurityBearer or BasicAuth
Responses
200

Successful response

400

The client specified an invalid argument

401

The authorization information is missing or invalid

403

Permission to access this endpoint is denied

404

The requested entity, such as a payment, was not found

429

Too many requests

500

An unexpected or internal server error

501

The operation was not implemented

503

Service is unavailable

504

Gateway has timed out

delete/webhook/config
Request samples
Response samples
application/json
{ }