Callback Groups

Create a callback group

post/v2/apps/{app_id}/integrations/{integration_id}/callback_groups

Request

  • Base URL
    https://api.tenjin.com
  • Auth
    HTTP bearer

Path parameters

app_idstring uuid required

Id of the app

integration_idinteger required

Id of the integration: its channel id

Request body

callback_group_template_idstring uuid required

Id of the callback group template the group is made from

event_definition_idstring uuid

Id of the event that sends the callbacks. Send event_definition_id or event; event_definition_id wins when both are sent

eventstring

Name of the event that sends the callbacks

activeboolean

Whether Tenjin sends the callbacks

callback_settingsobject

A value for each of the template's required_settings, for this callback group only

namestring

Name of the callback group

user_filter'all' | 'channel' | 'channel_and_organic' | 'defer_to_template'

Users the callbacks are sent for

Response

The created callback group

metaobject required

Always empty

Example response

{
  "data": {
    "attributes": {
      "active": true,
      "name": "Level 10",
      "user_filter": "channel",
      "integration_id": 18,
      "callback_settings": {
        "event_name": "level_10"
      },
      "event": "level_10"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.