Create a share trigger

curl --request POST \
  --url https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/shares \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channels": [
    "ANY"
  ],
  "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",
  "quality": "ANY",
  "share_types": [
    "ANY"
  ],
  "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/shares"

payload = {
    "channels": ["ANY"],
    "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",
    "quality": "ANY",
    "share_types": ["ANY"],
    "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({
    channels: ['ANY'],
    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',
    quality: 'ANY',
    share_types: ['ANY'],
    trigger_description: 'trigger_description',
    trigger_name: 'trigger_name',
    trigger_phase: 'MATCHING'
  })
};

fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/shares', 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/shares",
  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([
    'channels' => [
        'ANY'
    ],
    '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',
    'quality' => 'ANY',
    'share_types' => [
        'ANY'
    ],
    '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/shares"

	payload := strings.NewReader("{\n  \"channels\": [\n    \"ANY\"\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  \"negated\": true,\n  \"parent_trigger_group_name\": \"parent_trigger_group_name\",\n  \"quality\": \"ANY\",\n  \"share_types\": [\n    \"ANY\"\n  ],\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/shares")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"channels\": [\n    \"ANY\"\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  \"negated\": true,\n  \"parent_trigger_group_name\": \"parent_trigger_group_name\",\n  \"quality\": \"ANY\",\n  \"share_types\": [\n    \"ANY\"\n  ],\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/shares")

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  \"channels\": [\n    \"ANY\"\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  \"negated\": true,\n  \"parent_trigger_group_name\": \"parent_trigger_group_name\",\n  \"quality\": \"ANY\",\n  \"share_types\": [\n    \"ANY\"\n  ],\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": "SHARE",
  "channels": []
}

POST

campaigns

{campaignId}

{version}

controllers

{controllerId}

triggers

Create a share trigger

curl --request POST \
  --url https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/shares \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channels": [
    "ANY"
  ],
  "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",
  "quality": "ANY",
  "share_types": [
    "ANY"
  ],
  "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/shares"

payload = {
    "channels": ["ANY"],
    "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",
    "quality": "ANY",
    "share_types": ["ANY"],
    "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({
    channels: ['ANY'],
    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',
    quality: 'ANY',
    share_types: ['ANY'],
    trigger_description: 'trigger_description',
    trigger_name: 'trigger_name',
    trigger_phase: 'MATCHING'
  })
};

fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/shares', 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/shares",
  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([
    'channels' => [
        'ANY'
    ],
    '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',
    'quality' => 'ANY',
    'share_types' => [
        'ANY'
    ],
    '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/shares"

	payload := strings.NewReader("{\n  \"channels\": [\n    \"ANY\"\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  \"negated\": true,\n  \"parent_trigger_group_name\": \"parent_trigger_group_name\",\n  \"quality\": \"ANY\",\n  \"share_types\": [\n    \"ANY\"\n  ],\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/shares")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"channels\": [\n    \"ANY\"\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  \"negated\": true,\n  \"parent_trigger_group_name\": \"parent_trigger_group_name\",\n  \"quality\": \"ANY\",\n  \"share_types\": [\n    \"ANY\"\n  ],\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/shares")

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  \"channels\": [\n    \"ANY\"\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  \"negated\": true,\n  \"parent_trigger_group_name\": \"parent_trigger_group_name\",\n  \"quality\": \"ANY\",\n  \"share_types\": [\n    \"ANY\"\n  ],\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": "SHARE",
  "channels": []
}

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/shares request.

channels

enum<string>[]

required

Available options:

ANY,

EMAIL,

EXTOLE_EMAIL,

EXTOLE_TWITTER,

FACEBOOK,

TWITTER

quality

enum<string>

required

Available options:

ANY,

HIGH,

LOW

component_ids

string[]

component_references

object[]

Show child attributes

enabled

Choose between static or dynamic enabled

negated

Choose between static or dynamic negated

parent_trigger_group_name

Choose between static or dynamic parent trigger group name

Available options:

ANY,

EMAIL,

EXTOLE_EMAIL,

EXTOLE_TWITTER,

FACEBOOK,

TWITTER

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:

SHARE

channels

enum<string>[]

Available options:

ANY,

EMAIL,

EXTOLE_EMAIL,

EXTOLE_TWITTER,

FACEBOOK,

TWITTER

quality

enum<string>

Available options:

ANY,

HIGH,

LOW

Create a send-reward-event trigger Create a step event trigger

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Management Expert API

Create a share trigger

Authorizations

Path Parameters

Body

Response