CallbackSetting

All callback endpoints

Get all available callback endpoints

get
Authorizations
PRIVATE-TOKENstringRequired
Responses
chevron-right
200

OK

application/json
idinteger · integerRead-onlyRequired

Callback setting ID, can be used as callbackSettingId in other endpoints.

urlstringRequired

This is the url that the system will use when the callback is executed.

urlDescriptionstringOptional

Description of the callback setting.

headersstringOptional

For sending additional meta information about the callback request.

get
/v3/callback

Create a callback

post
Authorizations
PRIVATE-TOKENstringRequired
Body
idinteger · integerRead-onlyRequired

Callback setting ID, can be used as callbackSettingId in other endpoints.

urlstringRequired

This is the url that the system will use when the callback is executed.

urlDescriptionstringOptional

Description of the callback setting.

headersstringOptional

For sending additional meta information about the callback request.

Responses
chevron-right
200

OK

application/json
idinteger · integerRead-onlyRequired

Callback setting ID, can be used as callbackSettingId in other endpoints.

urlstringRequired

This is the url that the system will use when the callback is executed.

urlDescriptionstringOptional

Description of the callback setting.

headersstringOptional

For sending additional meta information about the callback request.

post
/v3/callback

Get a callback for a given callbackSettingId

get
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
callbackSettingIdintegerRequired

The Id of the callback setting

Responses
chevron-right
200

OK

application/json
idinteger · integerRead-onlyRequired

Callback setting ID, can be used as callbackSettingId in other endpoints.

urlstringRequired

This is the url that the system will use when the callback is executed.

urlDescriptionstringOptional

Description of the callback setting.

headersstringOptional

For sending additional meta information about the callback request.

get
/v3/callback/{callbackSettingId}

Update given callback

put
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
callbackSettingIdintegerRequired

The Id of the callback setting

Body
idinteger · integerRead-onlyRequired

Callback setting ID, can be used as callbackSettingId in other endpoints.

urlstringRequired

This is the url that the system will use when the callback is executed.

urlDescriptionstringOptional

Description of the callback setting.

headersstringOptional

For sending additional meta information about the callback request.

Responses
chevron-right
200

OK

application/json
idinteger · integerRead-onlyRequired

Callback setting ID, can be used as callbackSettingId in other endpoints.

urlstringRequired

This is the url that the system will use when the callback is executed.

urlDescriptionstringOptional

Description of the callback setting.

headersstringOptional

For sending additional meta information about the callback request.

put
/v3/callback/{callbackSettingId}

Delete given callback

delete
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
callbackSettingIdintegerRequired

The Id of the callback setting

Responses
delete
/v3/callback/{callbackSettingId}

No content

Last updated

Was this helpful?