Callback Setting

All callback endpoints

Get all available callback endpoints

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

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.

403

Invalid credentials

500

Internal Server Error

application/json

get/v3/callback

HTTPcURLJavaScriptPython

GET /v3/callback HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "url": "text",
    "urlDescription": "text",
    "headers": "text"
  }
]

Create a callback

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Body

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.

Responses

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.

403

Invalid credentials

422

Unprocessable Entity

500

Internal Server Error

application/json

post/v3/callback

HTTPcURLJavaScriptPython

POST /v3/callback HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "url": "text",
  "urlDescription": "text",
  "headers": "text"
}

[
  {
    "id": 1,
    "url": "text",
    "urlDescription": "text",
    "headers": "text"
  }
]

Get a callback for a given callbackSettingId

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

callbackSettingIdintegerRequired

The Id of the callback setting

Responses

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.

403

Invalid credentials

404

Invalid callbackSettingId

500

Internal Server Error

application/json

get/v3/callback/{callbackSettingId}

HTTPcURLJavaScriptPython

GET /v3/callback/{callbackSettingId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "url": "text",
    "urlDescription": "text",
    "headers": "text"
  }
]

Update given callback

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

callbackSettingIdintegerRequired

The Id of the callback setting

Body

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.

Responses

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.

403

Invalid credentials

404

Invalid callbackSettingId

422

Unprocessable Entity

500

Internal Server Error

application/json

put/v3/callback/{callbackSettingId}

HTTPcURLJavaScriptPython

PUT /v3/callback/{callbackSettingId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "url": "text",
  "urlDescription": "text",
  "headers": "text"
}

[
  {
    "id": 1,
    "url": "text",
    "urlDescription": "text",
    "headers": "text"
  }
]

Delete given callback

delete

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

callbackSettingIdintegerRequired

The Id of the callback setting

Responses

204

No Content

No content

403

Invalid credentials

404

Invalid callbackSettingId

500

Internal Server Error

application/json

delete/v3/callback/{callbackSettingId}

HTTPcURLJavaScriptPython

DELETE /v3/callback/{callbackSettingId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content