Extole Campaign Controllers Triggers API
The Campaign Controllers Triggers API from Extole — 63 operation(s) for campaign controllers triggers.
The Campaign Controllers Triggers API from Extole — 63 operation(s) for campaign controllers triggers.
openapi: 3.0.1
info:
description: 'Consumer-to-Extole integration endpoints: consumer event submission, zone rendering, profile management, and SDK-backing operations for browser and native app environments.'
title: Integration API - Consumer to Extole Audiences Campaign Controllers Triggers API
version: '1.0'
servers:
- description: Production
url: https://{brand}.extole.io
variables:
brand:
default: yourcompany
description: Your Extole client subdomain (e.g. 'mycompany' for mycompany.extole.io)
security:
- HEADER: []
- QUERY: []
- COOKIE: []
tags:
- name: Campaign Controllers Triggers
paths:
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers:
get:
description: Returns all triggers configured on the specified campaign controller, across all trigger types.
operationId: listCampaignControllerTriggers
parameters:
- in: path
name: campaignId
required: true
schema:
type: string
- in: path
name: version
required: true
schema:
pattern: (/version/.+)?
type: string
- in: path
name: controllerId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/CampaignControllerTriggerResponse'
type: array
description: Successful response
'400':
content:
application/json:
examples:
binding_error:
$ref: '#/components/examples/binding_error'
campaign_concurrent_update:
$ref: '#/components/examples/campaign_concurrent_update'
campaign_has_pending_changes:
$ref: '#/components/examples/campaign_has_pending_changes'
campaign_locked:
$ref: '#/components/examples/campaign_locked'
campaign_version_malformed:
$ref: '#/components/examples/campaign_version_malformed'
date_invalid:
$ref: '#/components/examples/date_invalid'
invalid_campaign_id:
$ref: '#/components/examples/invalid_campaign_id'
invalid_campaign_state:
$ref: '#/components/examples/invalid_campaign_state'
invalid_campaign_version:
$ref: '#/components/examples/invalid_campaign_version'
invalid_json:
$ref: '#/components/examples/invalid_json'
invalid_parameter:
$ref: '#/components/examples/invalid_parameter'
lock_missing_lock_types:
$ref: '#/components/examples/lock_missing_lock_types'
missing_request_body:
$ref: '#/components/examples/missing_request_body'
unlock_missing_lock_types:
$ref: '#/components/examples/unlock_missing_lock_types'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Bad Request
'401':
content:
application/json:
examples:
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unauthorized
'402':
content:
application/json:
examples:
payment_required:
$ref: '#/components/examples/payment_required'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Payment Required
'403':
content:
application/json:
examples:
access_denied:
$ref: '#/components/examples/access_denied'
invalid_campaign_controller_id:
$ref: '#/components/examples/invalid_campaign_controller_id'
invalid_controller_action_id:
$ref: '#/components/examples/invalid_controller_action_id'
invalid_controller_trigger_id:
$ref: '#/components/examples/invalid_controller_trigger_id'
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
missing_access_token:
$ref: '#/components/examples/missing_access_token'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Forbidden
'415':
content:
application/json:
examples:
unsupported_media_type:
$ref: '#/components/examples/unsupported_media_type'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unsupported Media Type
'429':
content:
application/json:
examples:
too_many_requests:
$ref: '#/components/examples/too_many_requests'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Too Many Requests
summary: List all triggers on a controller
tags:
- Campaign Controllers Triggers
x-extole-bundle: management-expert
x-extole-visibility: expert
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/built:
get:
description: Returns all triggers on the controller in their fully evaluated runtime form.
operationId: listBuiltCampaignControllerTriggers
parameters:
- in: path
name: campaignId
required: true
schema:
type: string
- in: path
name: version
required: true
schema:
pattern: (/version/.+)?
type: string
- in: path
name: controllerId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/BuiltCampaignControllerTriggerResponse'
type: array
description: Successful response
'400':
content:
application/json:
examples:
binding_error:
$ref: '#/components/examples/binding_error'
campaign_build_failed:
$ref: '#/components/examples/campaign_build_failed'
campaign_concurrent_update:
$ref: '#/components/examples/campaign_concurrent_update'
campaign_has_pending_changes:
$ref: '#/components/examples/campaign_has_pending_changes'
campaign_locked:
$ref: '#/components/examples/campaign_locked'
campaign_version_malformed:
$ref: '#/components/examples/campaign_version_malformed'
controller_state_misconfiguration:
$ref: '#/components/examples/controller_state_misconfiguration'
date_invalid:
$ref: '#/components/examples/date_invalid'
expression_invalid_syntax:
$ref: '#/components/examples/expression_invalid_syntax'
invalid_campaign_id:
$ref: '#/components/examples/invalid_campaign_id'
invalid_campaign_state:
$ref: '#/components/examples/invalid_campaign_state'
invalid_campaign_version:
$ref: '#/components/examples/invalid_campaign_version'
invalid_json:
$ref: '#/components/examples/invalid_json'
invalid_parameter:
$ref: '#/components/examples/invalid_parameter'
lock_missing_lock_types:
$ref: '#/components/examples/lock_missing_lock_types'
missing_request_body:
$ref: '#/components/examples/missing_request_body'
rebuild_campaigns_build_failed:
$ref: '#/components/examples/rebuild_campaigns_build_failed'
unlock_missing_lock_types:
$ref: '#/components/examples/unlock_missing_lock_types'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Bad Request
'401':
content:
application/json:
examples:
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unauthorized
'402':
content:
application/json:
examples:
payment_required:
$ref: '#/components/examples/payment_required'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Payment Required
'403':
content:
application/json:
examples:
access_denied:
$ref: '#/components/examples/access_denied'
invalid_campaign_controller_id:
$ref: '#/components/examples/invalid_campaign_controller_id'
invalid_controller_action_id:
$ref: '#/components/examples/invalid_controller_action_id'
invalid_controller_trigger_id:
$ref: '#/components/examples/invalid_controller_trigger_id'
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
missing_access_token:
$ref: '#/components/examples/missing_access_token'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Forbidden
'415':
content:
application/json:
examples:
unsupported_media_type:
$ref: '#/components/examples/unsupported_media_type'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unsupported Media Type
'429':
content:
application/json:
examples:
too_many_requests:
$ref: '#/components/examples/too_many_requests'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Too Many Requests
summary: List built triggers on a controller
tags:
- Campaign Controllers Triggers
x-extole-bundle: management-expert
x-extole-visibility: expert
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/accesses/{triggerId}:
get:
description: Returns the access trigger configuration for the specified trigger id on the given campaign controller.
operationId: getAccessTrigger
parameters:
- in: path
name: campaignId
required: true
schema:
type: string
- in: path
name: version
required: true
schema:
pattern: (/version/.+)?
type: string
- in: path
name: controllerId
required: true
schema:
type: string
- in: path
name: triggerId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignControllerTriggerAccessResponse'
description: Successful response
'400':
content:
application/json:
examples:
binding_error:
$ref: '#/components/examples/binding_error'
campaign_concurrent_update:
$ref: '#/components/examples/campaign_concurrent_update'
campaign_has_pending_changes:
$ref: '#/components/examples/campaign_has_pending_changes'
campaign_locked:
$ref: '#/components/examples/campaign_locked'
campaign_version_malformed:
$ref: '#/components/examples/campaign_version_malformed'
date_invalid:
$ref: '#/components/examples/date_invalid'
invalid_campaign_id:
$ref: '#/components/examples/invalid_campaign_id'
invalid_campaign_state:
$ref: '#/components/examples/invalid_campaign_state'
invalid_campaign_version:
$ref: '#/components/examples/invalid_campaign_version'
invalid_json:
$ref: '#/components/examples/invalid_json'
invalid_parameter:
$ref: '#/components/examples/invalid_parameter'
lock_missing_lock_types:
$ref: '#/components/examples/lock_missing_lock_types'
missing_request_body:
$ref: '#/components/examples/missing_request_body'
unlock_missing_lock_types:
$ref: '#/components/examples/unlock_missing_lock_types'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Bad Request
'401':
content:
application/json:
examples:
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unauthorized
'402':
content:
application/json:
examples:
payment_required:
$ref: '#/components/examples/payment_required'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Payment Required
'403':
content:
application/json:
examples:
access_denied:
$ref: '#/components/examples/access_denied'
invalid_campaign_controller_id:
$ref: '#/components/examples/invalid_campaign_controller_id'
invalid_controller_action_id:
$ref: '#/components/examples/invalid_controller_action_id'
invalid_controller_trigger_id:
$ref: '#/components/examples/invalid_controller_trigger_id'
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
missing_access_token:
$ref: '#/components/examples/missing_access_token'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Forbidden
'415':
content:
application/json:
examples:
unsupported_media_type:
$ref: '#/components/examples/unsupported_media_type'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unsupported Media Type
'429':
content:
application/json:
examples:
too_many_requests:
$ref: '#/components/examples/too_many_requests'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Too Many Requests
summary: Get an access trigger
tags:
- Campaign Controllers Triggers
x-extole-bundle: management-expert
x-extole-visibility: expert
put:
description: Updates the access trigger on the specified campaign controller. Only fields present in the request body are changed. Returns the updated trigger.
operationId: updateAccessTrigger
parameters:
- in: path
name: campaignId
required: true
schema:
type: string
- in: path
name: version
required: true
schema:
pattern: (/version/.+)?
type: string
- in: path
name: controllerId
required: true
schema:
type: string
- in: path
name: triggerId
required: true
schema:
type: string
requestBody:
content:
application/json:
example:
component_ids:
- component_id
component_references:
- component_id: component_id
socket_names:
- socket_name
enabled: true
negated: true
parent_trigger_group_name: parent_trigger_group_name
trigger_description: trigger_description
trigger_name: trigger_name
trigger_phase: MATCHING
trusted_scopes:
- BACKEND
schema:
$ref: '#/components/schemas/CampaignControllerTriggerAccessRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignControllerTriggerAccessResponse'
description: Successful response
'400':
content:
application/json:
examples:
binding_error:
$ref: '#/components/examples/binding_error'
campaign_build_failed:
$ref: '#/components/examples/campaign_build_failed'
campaign_component_absolute_name_missing:
$ref: '#/components/examples/campaign_component_absolute_name_missing'
campaign_component_description_out_of_range:
$ref: '#/components/examples/campaign_component_description_out_of_range'
campaign_component_display_name_contains_illegal_character:
$ref: '#/components/examples/campaign_component_display_name_contains_illegal_character'
campaign_component_display_name_out_of_range:
$ref: '#/components/examples/campaign_component_display_name_out_of_range'
campaign_component_id_missing:
$ref: '#/components/examples/campaign_component_id_missing'
campaign_component_name_already_in_use:
$ref: '#/components/examples/campaign_component_name_already_in_use'
campaign_component_name_contains_illegal_character:
$ref: '#/components/examples/campaign_component_name_contains_illegal_character'
campaign_component_name_out_of_range:
$ref: '#/components/examples/campaign_component_name_out_of_range'
campaign_component_type_validation_failed:
$ref: '#/components/examples/campaign_component_type_validation_failed'
campaign_concurrent_update:
$ref: '#/components/examples/campaign_concurrent_update'
campaign_controller_trigger_access_missing_trusted_scopes:
$ref: '#/components/examples/campaign_controller_trigger_access_missing_trusted_scopes'
campaign_controller_trigger_description_length_out_of_range:
$ref: '#/components/examples/campaign_controller_trigger_description_length_out_of_range'
campaign_controller_trigger_name_invalid:
$ref: '#/components/examples/campaign_controller_trigger_name_invalid'
campaign_controller_trigger_name_length:
$ref: '#/components/examples/campaign_controller_trigger_name_length'
campaign_has_pending_changes:
$ref: '#/components/examples/campaign_has_pending_changes'
campaign_locked:
$ref: '#/components/examples/campaign_locked'
campaign_stale_version:
$ref: '#/components/examples/campaign_stale_version'
campaign_version_malformed:
$ref: '#/components/examples/campaign_version_malformed'
circular_component_reference:
$ref: '#/components/examples/circular_component_reference'
component_facets_not_found:
$ref: '#/components/examples/component_facets_not_found'
controller_build_failed:
$ref: '#/components/examples/controller_build_failed'
controller_state_misconfiguration:
$ref: '#/components/examples/controller_state_misconfiguration'
date_invalid:
$ref: '#/components/examples/date_invalid'
excessive_component_reference:
$ref: '#/components/examples/excessive_component_reference'
expression_invalid_syntax:
$ref: '#/components/examples/expression_invalid_syntax'
external_element_is_referenced_by_active_configuration:
$ref: '#/components/examples/external_element_is_referenced_by_active_configuration'
external_elements_cannot_have_multiple_references:
$ref: '#/components/examples/external_elements_cannot_have_multiple_references'
invalid_campaign_id:
$ref: '#/components/examples/invalid_campaign_id'
invalid_campaign_state:
$ref: '#/components/examples/invalid_campaign_state'
invalid_campaign_version:
$ref: '#/components/examples/invalid_campaign_version'
invalid_component_installed_into_socket:
$ref: '#/components/examples/invalid_component_installed_into_socket'
invalid_component_reference:
$ref: '#/components/examples/invalid_component_reference'
invalid_component_reference_socket_name:
$ref: '#/components/examples/invalid_component_reference_socket_name'
invalid_external_component_reference:
$ref: '#/components/examples/invalid_external_component_reference'
invalid_json:
$ref: '#/components/examples/invalid_json'
invalid_parameter:
$ref: '#/components/examples/invalid_parameter'
invalid_trigger_phase:
$ref: '#/components/examples/invalid_trigger_phase'
lock_missing_lock_types:
$ref: '#/components/examples/lock_missing_lock_types'
missing_request_body:
$ref: '#/components/examples/missing_request_body'
orphan_external_component_reference:
$ref: '#/components/examples/orphan_external_component_reference'
parent_trigger_group_name_does_not_exist:
$ref: '#/components/examples/parent_trigger_group_name_does_not_exist'
parent_trigger_group_name_is_not_a_group:
$ref: '#/components/examples/parent_trigger_group_name_is_not_a_group'
rebuild_campaigns_build_failed:
$ref: '#/components/examples/rebuild_campaigns_build_failed'
redundant_component_reference:
$ref: '#/components/examples/redundant_component_reference'
self_component_reference:
$ref: '#/components/examples/self_component_reference'
trigger_belongs_to_a_cycle:
$ref: '#/components/examples/trigger_belongs_to_a_cycle'
trigger_group_is_not_empty:
$ref: '#/components/examples/trigger_group_is_not_empty'
trigger_type_not_supported:
$ref: '#/components/examples/trigger_type_not_supported'
triggers_with_duplicate_name:
$ref: '#/components/examples/triggers_with_duplicate_name'
unlock_missing_lock_types:
$ref: '#/components/examples/unlock_missing_lock_types'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Bad Request
'401':
content:
application/json:
examples:
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unauthorized
'402':
content:
application/json:
examples:
payment_required:
$ref: '#/components/examples/payment_required'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Payment Required
'403':
content:
application/json:
examples:
access_denied:
$ref: '#/components/examples/access_denied'
invalid_campaign_controller_id:
$ref: '#/components/examples/invalid_campaign_controller_id'
invalid_controller_action_id:
$ref: '#/components/examples/invalid_controller_action_id'
invalid_controller_trigger_id:
$ref: '#/components/examples/invalid_controller_trigger_id'
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
missing_access_token:
$ref: '#/components/examples/missing_access_token'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Forbidden
'415':
content:
application/json:
examples:
unsupported_media_type:
$ref: '#/components/examples/unsupported_media_type'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unsupported Media Type
'429':
content:
application/json:
examples:
too_many_requests:
$ref: '#/components/examples/too_many_requests'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Too Many Requests
summary: Update an access trigger
tags:
- Campaign Controllers Triggers
x-extole-bundle: management-expert
x-extole-visibility: expert
delete:
description: Removes the access trigger from the specified campaign controller. Returns the deleted trigger record.
operationId: deleteAccessTrigger
parameters:
- in: path
name: campaignId
required: true
schema:
type: string
- in: path
name: version
required: true
schema:
pattern: (/version/.+)?
type: string
- in: path
name: controllerId
required: true
schema:
type: string
- in: path
name: triggerId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignControllerTriggerAccessResponse'
description: Successful response
'400':
content:
application/json:
examples:
binding_error:
$ref: '#/components/examples/binding_error'
campaign_build_failed:
$ref: '#/components/examples/campaign_build_failed'
campaign_concurrent_update:
$ref: '#/components/examples/campaign_concurrent_update'
campaign_has_pending_changes:
$ref: '#/components/examples/campaign_has_pending_changes'
campaign_locked:
$ref: '#/components/examples/campaign_locked'
campaign_stale_version:
$ref: '#/components/examples/campaign_stale_version'
campaign_version_malformed:
$ref: '#/components/examples/campaign_version_malformed'
controller_build_failed:
$ref: '#/components/examples/controller_build_failed'
controller_state_misconfiguration:
$ref: '#/components/examples/controller_state_misconfiguration'
date_invalid:
$ref: '#/components/examples/date_invalid'
expression_invalid_syntax:
$ref: '#/components/examples/expression_invalid_syntax'
invalid_campaign_id:
$ref: '#/components/examples/invalid_campaign_id'
invalid_campaign_state:
$ref: '#/components/examples/invalid_campaign_state'
invalid_campaign_version:
$ref: '#/components/examples/invalid_campaign_version'
invalid_json:
$ref: '#/components/examples/invalid_json'
invalid_parameter:
$ref: '#/components/examples/invalid_parameter'
invalid_trigger_phase:
$ref: '#/components/examples/invalid_trigger_phase'
lock_missing_lock_types:
$ref: '#/components/examples/lock_missing_lock_types'
missing_request_body:
$ref: '#/components/examples/missing_request_body'
parent_trigger_group_name_does_not_exist:
$ref: '#/components/examples/parent_trigger_group_name_does_not_exist'
parent_trigger_group_name_is_not_a_group:
$ref: '#/components/examples/parent_trigger_group_name_is_not_a_group'
rebuild_campaigns_build_failed:
$ref: '#/components/examples/rebuild_campaigns_build_failed'
trigger_belongs_to_a_cycle:
$ref: '#/components/examples/trigger_belongs_to_a_cycle'
trigger_group_is_not_empty:
$ref: '#/components/examples/trigger_group_is_not_empty'
triggers_with_duplicate_name:
$ref: '#/components/examples/triggers_with_duplicate_name'
unlock_missing_lock_types:
$ref: '#/components/examples/unlock_missing_lock_types'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Bad Request
'401':
content:
application/json:
examples:
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unauthorized
'402':
content:
application/json:
examples:
payment_required:
$ref: '#/components/examples/payment_required'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Payment Required
'403':
content:
application/json:
examples:
access_denied:
$ref: '#/components/examples/access_denied'
invalid_campaign_controller_id:
$ref: '#/components/examples/invalid_campaign_controller_id'
invalid_controller_action_id:
$ref: '#/components/examples/invalid_controller_action_id'
invalid_controller_trigger_id:
$ref: '#/components/examples/invalid_controller_trigger_id'
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
missing_access_token:
$ref: '#/components/examples/missing_access_token'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Forbidden
'415':
content:
application/json:
examples:
unsupported_media_type:
$ref: '#/components/examples/unsupported_media_type'
schema:
$ref
# --- truncated at 32 KB (1897 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/extole/refs/heads/main/openapi/extole-campaign-controllers-triggers-api-openapi.yml