Create an audience membership event trigger

curl --request POST \
  --url https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/audience-membership-events \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "audience_ids": [
    "audience_id"
  ],
  "component_ids": [
    "component_id"
  ],
  "component_references": [
    {
      "component_id": "component_id",
      "socket_names": [
        "socket_name"
      ]
    }
  ],
  "enabled": true,
  "event_types": [
    "CREATED"
  ],
  "negated": true,
  "parent_trigger_group_name": "parent_trigger_group_name",
  "trigger_description": "trigger_description",
  "trigger_name": "trigger_name",
  "trigger_phase": "MATCHING"
}
'

import requests

url = "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/audience-membership-events"

payload = {
    "audience_ids": ["audience_id"],
    "component_ids": ["component_id"],
    "component_references": [
        {
            "component_id": "component_id",
            "socket_names": ["socket_name"]
        }
    ],
    "enabled": True,
    "event_types": ["CREATED"],
    "negated": True,
    "parent_trigger_group_name": "parent_trigger_group_name",
    "trigger_description": "trigger_description",
    "trigger_name": "trigger_name",
    "trigger_phase": "MATCHING"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    audience_ids: ['audience_id'],
    component_ids: ['component_id'],
    component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
    enabled: true,
    event_types: ['CREATED'],
    negated: true,
    parent_trigger_group_name: 'parent_trigger_group_name',
    trigger_description: 'trigger_description',
    trigger_name: 'trigger_name',
    trigger_phase: 'MATCHING'
  })
};

fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/audience-membership-events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/audience-membership-events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'audience_ids' => [
        'audience_id'
    ],
    'component_ids' => [
        'component_id'
    ],
    'component_references' => [
        [
                'component_id' => 'component_id',
                'socket_names' => [
                                'socket_name'
                ]
        ]
    ],
    'enabled' => true,
    'event_types' => [
        'CREATED'
    ],
    'negated' => true,
    'parent_trigger_group_name' => 'parent_trigger_group_name',
    'trigger_description' => 'trigger_description',
    'trigger_name' => 'trigger_name',
    'trigger_phase' => 'MATCHING'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/audience-membership-events"

	payload := strings.NewReader("{\n  \"audience_ids\": [\n    \"audience_id\"\n  ],\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"enabled\": true,\n  \"event_types\": [\n    \"CREATED\"\n  ],\n  \"negated\": true,\n  \"parent_trigger_group_name\": \"parent_trigger_group_name\",\n  \"trigger_description\": \"trigger_description\",\n  \"trigger_name\": \"trigger_name\",\n  \"trigger_phase\": \"MATCHING\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/audience-membership-events")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"audience_ids\": [\n    \"audience_id\"\n  ],\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"enabled\": true,\n  \"event_types\": [\n    \"CREATED\"\n  ],\n  \"negated\": true,\n  \"parent_trigger_group_name\": \"parent_trigger_group_name\",\n  \"trigger_description\": \"trigger_description\",\n  \"trigger_name\": \"trigger_name\",\n  \"trigger_phase\": \"MATCHING\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/audience-membership-events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"audience_ids\": [\n    \"audience_id\"\n  ],\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"enabled\": true,\n  \"event_types\": [\n    \"CREATED\"\n  ],\n  \"negated\": true,\n  \"parent_trigger_group_name\": \"parent_trigger_group_name\",\n  \"trigger_description\": \"trigger_description\",\n  \"trigger_name\": \"trigger_name\",\n  \"trigger_phase\": \"MATCHING\"\n}"

response = http.request(request)
puts response.read_body

{
  "component_ids": [
    "<string>"
  ],
  "component_references": [
    {
      "component_id": "<string>",
      "socket_names": [
        "<string>"
      ]
    }
  ],
  "enabled": true,
  "negated": true,
  "parent_trigger_group_name": "<string>",
  "trigger_description": "<string>",
  "trigger_id": "<string>",
  "trigger_name": "<string>",
  "trigger_type": "AUDIENCE_MEMBERSHIP_EVENT",
  "audience_ids": [
    "<string>"
  ],
  "event_types": []
}

POST

campaigns

{campaignId}

{version}

controllers

{controllerId}

triggers

audience-membership-events

Create an audience membership event trigger

curl --request POST \
  --url https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/audience-membership-events \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "audience_ids": [
    "audience_id"
  ],
  "component_ids": [
    "component_id"
  ],
  "component_references": [
    {
      "component_id": "component_id",
      "socket_names": [
        "socket_name"
      ]
    }
  ],
  "enabled": true,
  "event_types": [
    "CREATED"
  ],
  "negated": true,
  "parent_trigger_group_name": "parent_trigger_group_name",
  "trigger_description": "trigger_description",
  "trigger_name": "trigger_name",
  "trigger_phase": "MATCHING"
}
'

import requests

url = "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/audience-membership-events"

payload = {
    "audience_ids": ["audience_id"],
    "component_ids": ["component_id"],
    "component_references": [
        {
            "component_id": "component_id",
            "socket_names": ["socket_name"]
        }
    ],
    "enabled": True,
    "event_types": ["CREATED"],
    "negated": True,
    "parent_trigger_group_name": "parent_trigger_group_name",
    "trigger_description": "trigger_description",
    "trigger_name": "trigger_name",
    "trigger_phase": "MATCHING"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    audience_ids: ['audience_id'],
    component_ids: ['component_id'],
    component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
    enabled: true,
    event_types: ['CREATED'],
    negated: true,
    parent_trigger_group_name: 'parent_trigger_group_name',
    trigger_description: 'trigger_description',
    trigger_name: 'trigger_name',
    trigger_phase: 'MATCHING'
  })
};

fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/audience-membership-events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/audience-membership-events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'audience_ids' => [
        'audience_id'
    ],
    'component_ids' => [
        'component_id'
    ],
    'component_references' => [
        [
                'component_id' => 'component_id',
                'socket_names' => [
                                'socket_name'
                ]
        ]
    ],
    'enabled' => true,
    'event_types' => [
        'CREATED'
    ],
    'negated' => true,
    'parent_trigger_group_name' => 'parent_trigger_group_name',
    'trigger_description' => 'trigger_description',
    'trigger_name' => 'trigger_name',
    'trigger_phase' => 'MATCHING'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/audience-membership-events"

	payload := strings.NewReader("{\n  \"audience_ids\": [\n    \"audience_id\"\n  ],\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"enabled\": true,\n  \"event_types\": [\n    \"CREATED\"\n  ],\n  \"negated\": true,\n  \"parent_trigger_group_name\": \"parent_trigger_group_name\",\n  \"trigger_description\": \"trigger_description\",\n  \"trigger_name\": \"trigger_name\",\n  \"trigger_phase\": \"MATCHING\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/audience-membership-events")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"audience_ids\": [\n    \"audience_id\"\n  ],\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"enabled\": true,\n  \"event_types\": [\n    \"CREATED\"\n  ],\n  \"negated\": true,\n  \"parent_trigger_group_name\": \"parent_trigger_group_name\",\n  \"trigger_description\": \"trigger_description\",\n  \"trigger_name\": \"trigger_name\",\n  \"trigger_phase\": \"MATCHING\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/audience-membership-events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"audience_ids\": [\n    \"audience_id\"\n  ],\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"enabled\": true,\n  \"event_types\": [\n    \"CREATED\"\n  ],\n  \"negated\": true,\n  \"parent_trigger_group_name\": \"parent_trigger_group_name\",\n  \"trigger_description\": \"trigger_description\",\n  \"trigger_name\": \"trigger_name\",\n  \"trigger_phase\": \"MATCHING\"\n}"

response = http.request(request)
puts response.read_body

{
  "component_ids": [
    "<string>"
  ],
  "component_references": [
    {
      "component_id": "<string>",
      "socket_names": [
        "<string>"
      ]
    }
  ],
  "enabled": true,
  "negated": true,
  "parent_trigger_group_name": "<string>",
  "trigger_description": "<string>",
  "trigger_id": "<string>",
  "trigger_name": "<string>",
  "trigger_type": "AUDIENCE_MEMBERSHIP_EVENT",
  "audience_ids": [
    "<string>"
  ],
  "event_types": []
}

Authorizations

Authorization

string

header

required

Path Parameters

campaignId

string

required

version

string

required

Pattern: (/version/.+)?

controllerId

string

required

Body

application/json

Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/triggers/audience-membership-events request.

audience_ids

Choose between static or dynamic audience ids

component_ids

string[]

component_references

object[]

Show child attributes

enabled

Choose between static or dynamic enabled

event_types

Choose between static or dynamic event types

Available options:

CREATED,

REMOVED,

UPDATED

negated

Choose between static or dynamic negated

parent_trigger_group_name

Choose between static or dynamic parent trigger group name

trigger_description

Choose between static or dynamic trigger description

trigger_name

Choose between static or dynamic trigger name

trigger_phase

Choose between static or dynamic trigger phase

Available options:

MATCHING,

QUALIFYING,

QUALITY

Response

Successful response

component_ids

string[]

component_references

object[]

Show child attributes

enabled

The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.

negated

The negated as configured: a literal value, or an expression (type:string) when defined dynamically.

parent_trigger_group_name

The parent trigger group name as configured: a literal value, or an expression (type:string) when defined dynamically.

trigger_description

The trigger description as configured: a literal value, or an expression (type:string) when defined dynamically.

trigger_id

string

trigger_name

The trigger name as configured: a literal value, or an expression (type:string) when defined dynamically.

trigger_phase

The trigger phase as configured: a literal value, or an expression (type:string) when defined dynamically.

Available options:

MATCHING,

QUALIFYING,

QUALITY

trigger_type

enum<string>

Available options:

AUDIENCE_MEMBERSHIP_EVENT

audience_ids

The audience ids as configured: a literal value, or an expression (type:string) when defined dynamically.

event_types

The event types as configured: a literal value, or an expression (type:string) when defined dynamically.

Available options:

CREATED,

REMOVED,

UPDATED

Create an access trigger Create an audience membership trigger

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Management Expert API

Create an audience membership event trigger

Authorizations

Path Parameters

Body

Response