Automations

Use this endpoint to obtain details on Adaptix's automations.

<?php
use Adaptix\AdaptixApi;
use Adaptix\Auth\ApiAuth;

// ...
$initAuth    = new ApiAuth();
$auth        = $initAuth->newAuth($settings);
$apiUrl      = "https://your-adaptix.ai";
$api         = new AdaptixApi();
$automationApi = $api->newApi("automations", $auth, $apiUrl);

Get Automation

<?php

//...
$automation = $automationApi->get($id);

{
    "campaign": {
        "id": 3,
        "name": "Email A/B Test",
        "description": null,
        "isPublished": true,
        "publishUp": null,
        "publishDown": null,
        "dateAdded": "2015-07-15T15:06:02-05:00",
        "createdBy": 1,
        "createdByUser": "Joe Smith",
        "dateModified": "2015-07-20T13:11:56-05:00",
        "modifiedBy": 1,
        "modifiedByUser": "Joe Smith",
        "category": null,
        "events": {
            "28": {
                "id": 28,
                "type": "lead.changepoints",
                "eventType": "action",
                "name": "Adjust lead points",
                "description": null,
                "order": 1,
                "properties": {
                  "points": 20
                },
                "triggerDate": null,
                "triggerInterval": 1,
                "triggerIntervalUnit": "d",
                "triggerMode": "immediate",
                "children": [],
                "parent": null,
                "decisionPath": null
            }
        }
    }
}

Get an individual automation by ID.

HTTP Request

GET /automations/ID

Response

Expected Response Code: 200

See JSON code example.

Automation Properties

Name	Type	Description
id	int	ID of the automation
name	string	Name of the automation
description	string/null	Description of the automation
alias	string	Used to generate the URL for the automation
isPublished	bool	Published state
publishUp	datetime/null	Date/time when the automation should be published
publishDown	datetime/null	Date/time the automation should be un published
dateAdded	datetime	Date/time automation was created
createdBy	int	ID of the user that created the automation
createdByUser	string	Name of the user that created the automation
dateModified	datetime/null	Date/time automation was last modified
modifiedBy	int	ID of the user that last modified the automation
modifiedByUser	string	Name of the user that last modified the automation
events	array	Array of Event entities for the automation. See below.

Event Properties

Name	Type	Description
id	int	ID of the event
name	string	Name of the event
description	string	Optional description for the event
type	string	Type of event
eventType	string	"action" or "decision"
order	int	Order in relation to the other events (used for levels)
properties	object	Configured properties for the event
triggerMode	string	"immediate", "interval" or "date"
triggerDate	datetime/null	Date/time of when the event should trigger if triggerMode is "date"
triggerInterval	int/null	Interval for when the event should trigger
triggerIntervalUnit	string	Interval unit for when the event should trigger. Options are i = minutes, h = hours, d = days, m = months, y = years
children	array	Array of this event's children ,
parent	object/null	This event's parent
decisionPath	string/null	If the event is connected into an action, this will be "no" for the non-decision path or "yes" for the actively followed path.

List Automations

<?php
// ...

$automations = $automationApi->getList($searchFilter, $start, $limit, $orderBy, $orderByDir, $publishedOnly, $minimal);

{
    "total": 1,
    "campaigns": {
        "3": {
            "id": 3,
            "name": "Welcome Automation",
            "description": null,
            "isPublished": true,
            "publishUp": null,
            "publishDown": null,
            "dateAdded": "2015-07-15T15:06:02-05:00",
            "createdBy": 1,
            "createdByUser": "Joe Smith",
            "dateModified": "2015-07-20T13:11:56-05:00",
            "modifiedBy": 1,
            "modifiedByUser": "Joe Smith",
            "category": null,
            "events": {
                "22": {
                    "id": 22,
                    "type": "email.send",
                    "eventType": "action",
                    "name": "Send welcome email",
                    "description": null,
                    "order": 1,
                    "properties": {
                        "email": 1
                    },
                    "triggerMode": "immediate",
                    "triggerDate": null,
                    "triggerInterval": null,
                    "triggerIntervalUnit": null,
                    "children": [],
                    "parent": null,
                    "decisionPath": null
                },
                "28": {
                    "id": 28,
                    "type": "lead.changepoints",
                    "eventType": "action",
                    "name": "Adjust lead points",
                    "description": null,
                    "order": 2,
                    "properties": {
                        "points": 20
                    },
                    "triggerMode": "immediate",                
                    "triggerDate": null,
                    "triggerInterval": null,
                    "triggerIntervalUnit": null,
                    "children": [],
                    "parent": null,
                    "decisionPath": null
                }
            }
        }
    }
}

HTTP Request

GET /automations

Query Parameters

Name	Description
search	String or search command to filter entities by.
start	Starting row for the entities returned. Defaults to 0.
limit	Limit number of entities to return. Defaults to the system configuration for pagination (30).
orderBy	Column to sort by. Can use any column listed in the response.
orderByDir	Sort direction: asc or desc.
published	Only return currently published entities.
minimal	Return only array of entities without additional lists in it.

Response

Expected Response Code: 200

See JSON code example.

Properties

Same as Get Automation.

List Automation Contacts

This endpoint is basically an alias for the stats endpoint with 'campaign_leads' table and campaign_id specified. Other parameters are the same as in the stats endpoint.

<?php
// ...

$response = $automationApi->getContacts($automationId, $start, $limit, $order, $where);

{  
  "total":"1",
  "contacts":[  
    {  
      "campaign_id":"311",
      "lead_id":"3126",
      "date_added":"2017-01-25 15:11:10",
      "manually_removed":"0",
      "manually_added":"1"
    }
  ]
}

HTTP Request

GET /automations/ID/contacts

Query Parameters

Response

Expected Response Code: 200

See JSON code example.

Create Automation

<?php

$data = array(
    'name'        => 'Automation A',
    'description' => 'This is my first automation created via API.',
    'isPublished' => true,
    'lists'        => array(1),
    'events'      => array(
        'name'      => 'Send welcome email',
        'eventType' => 'action',
        'type'      => 'email.send',
        'order'     => '1',
        'properties'    => array(
            'email'     => 1,
            'triggerMode'   => 'immediate',
        )
    )
);

$automation = $automationApi->create($data);

Create a new automation. To see more advanced example with campaing events and so on, see the unit tests.

HTTP Request

POST /automations/new

Post Parameters

Name	Description
name	Automation name is the only required field
alias	string
description	A description of the automation.
isPublished	A value of false or true

Response

Expected Response Code: 201

Properties

Same as Get Automation.

Clone an Automation

<?php

$automationId = 12;

$automation = $automationApi->cloneAutomation($automationId);

Clone an existing automation. To see more advanced example with automation events and so on, see the unit tests.

HTTP Request

POST /automations/clone/AUTOMATION_ID

Response

Expected Response Code: 201

Properties

Same as Get Automation.

Edit Automation

<?php

$id   = 1;
$data = array(
    'name'        => 'New automation name',
    'isPublished' => false
);

// Create new a automation of ID 1 is not found?
$createIfNotFound = true;

$automation = $automationApi->edit($id, $data, $createIfNotFound);

Edit a new automation. Note that this supports PUT or PATCH depending on the desired behavior.

PUT creates a automation if the given ID does not exist and clears all the automation information, adds the information from the request. PATCH fails if the automation with the given ID does not exist and updates the automation field values with the values form the request.

HTTP Request

To edit a automation and return a 404 if the automation is not found:

PATCH /automations/ID/edit

To edit a automation and create a new one if the automation is not found:

PUT /automations/ID/edit

Post Parameters

Name	Description
name	Automation name is the only required field
alias	Name alias generated automatically if not set
description	A description of the automation.
isPublished	A value of false or true

Response

If PUT, the expected response code is 200 if the automation was edited or 201 if created.

If PATCH, the expected response code is 200.

Properties

Same as Get Automation.

Delete Automation

<?php

$automation = $automationApi->delete($id);

Delete a automation.

HTTP Request

DELETE /automations/ID/delete

Response

Expected Response Code: 200

Properties

Same as Get Automation.

Add Contact to a Automation

<?php

//...
$response = $automationApi->addContact($automationId, $contactId);
if (!isset($response['success'])) {
    // handle error
}

{
    "success": true
}

Manually add a contact to a specific automation.

HTTP Request

POST /automations/AUTOMATION_ID/contact/CONTACT_ID/add

Response

Expected Response Code: 200

See JSON code example.

Remove Contact from a Automation

<?php

//...
$response = $listApi->removeContact($automationId, $contactId);
if (!isset($response['success'])) {
    // handle error
}

{
    "success": true
}

Manually remove a contact from a specific automation.

HTTP Request

POST /automations/AUTOMATION_ID/contact/CONTACT_ID/remove

Response

Expected Response Code: 200

See JSON code example.