v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB

Callbacks

Create Callback

Create a Callback to notify you at the URL when the object_type changes

post/callbacks

Request body

urlstring required

URL to which the callbacks will notify

object_typestring required

Object or entity to which the callbacks refer. Please refer to Callbacks for a list of object types.

enabledstring required

Toggle whether callback is active or inactive.

Example request

{
  "url": "https://httpbin.org",
  "object_type": "users",
  "enabled": "true"
}

Response

Example response

{
  "callbacks": {
    "id": "f92d4ca1-4ee5-43f3-9e34-ca5f759c5e76",
    "description": "Users Callback",
    "url": "https://httpbin.org/post",
    "object_type": "users",
    "enabled": true
  }
}