Skip to main content

Trigger events

Trigger event subscriptions#

In addition to data driven events, ACTITO produces events when internal operations occur.
Those events are names "triggers" and happen on many ACTITO modules.

Available triggers#

ETL executions#

  • STARTED

Be notified as soon as a scheduled etl execution is started.

  • FINISHED

Be notified as soon as a scheduled etl execution is finished.

Custom actions#

  • TRIGGER

Be notified as soon as a profile reaches your custom action in an ACTITO scenario.

File reference synchronizations#

  • STARTED

Be notified as soon as the synchronization of a file reference is started.

  • FINISHED

Be notified as soon as the synchronization of a file reference is finished.

Payload samples#

ETL Executions#

Trigger event : All finished etl execution of etl with id 123456

ONE_BY_ONE#

{  "id": "95f1cebc-4dd7-4246-83a1-164d8da8c583",  "data": {    "etl.id": "123456",    "etl.executionId": "123654987",    "etl.executionStatus": "SUCCESS",    "_links": {      "etlExecution": {        "href": "https://api.actito.com/v5/entities/MyEntity/etl-executions/123654987"      },      "etl": {        "href": "https://api.actito.com/v5/entities/MyEntity/etls/123456"      }    }  },  "_links": {    "webhook": {      "href": "https://api.actito.com/v4/entity/MyEntity/webhookSubscription/123789654"    }  }}

BULK#

{ "id": "201373e4-22f9-4165-b394-6223b692eebc", "data": [   {     "etl.id": "123456",     "etl.executionId": "123654987",     "etl.executionStatus": "SUCCESS",     "_links": {       "etlExecution": {         "href": "https://api.actito.com/v5/entities/MyEntity/etl-executions/123654987"       },       "etl": {         "href": "https://api.actito.com/v5/entities/MyEntity/etls/123456"       }     }   },   {     "etl.id": "123456",     "etl.executionId": "123654988",     "etl.executionStatus": "WITH_ERROR",     "_links": {       "etlExecution": {         "href": "https://api.actito.com/v5/entities/MyEntity/etl-executions/123654988"       },       "etl": {         "href": "https://api.actito.com/v5/entities/MyEntity/etls/123456"       }     }   } ], "_links": {   "webhook": {     "href": "https://api.actito.com/ActitoWebServices/ws/v4/entity/MyEntity/webhookSubscription/2"   } }}

​

Custom actions#

​ Trigger event : All triggered event for custom action with id 123456

ONE_BY_ONE#

{  "id": "95f1cebc-4dd7-4246-83a1-164d8da8c583",  "data": {    "actionParameters.campaignId": "987654",    "actionParameters.campaignGroup": "Notifications",    "profileAttributes.businessId": "4f5427b0-0134-4f4b-971a-98a9f03d0ff5",    "profileAttributes.emailAddress": "john.smith@actito.com",    "scenarioExecutionContextAttributes.startEventType": "CUSTOM_TABLE#NEW_RECORD",    "scenarioExecutionContextAttributes.startEventId": "e46a7856-3e4d-4a88-baa5-a3d599b30550",    "_links": {      "notifyOK": {        "href": "https://www.actito.com/ca/OK_6946_67617411_4JK5QKY19YGM_54501_aHR0cDovL3d3dy5sdW5jaGdhcmRlbi5iZS9mci9teWx1bmNoZ2FyZGVu"      },      "notifyKO": {        "href": "https://www.actito.com/ca/KO_6946_67617411_4JK5QKY19YGM_54501_aHR0cDovL3d3dy5sdW5ds4d45sfJFJ5iZS9mci9teWx1bmNoZ2FyZGVu"      },      "customAction": {        "href": "/v5/entities/MyEntity/custom-actions/123456"      }    }  },  "_links": {    "webhook": {      "href": "/v4/entity/MyEntity/webhookSubscription/123987456"    }  }}

BULK#

{ "id": "201373e4-22f9-4165-b394-6223b692eebc", "data": [   {     "actionParameters.campaignId": "987654",     "actionParameters.campaignGroup": "Notifications",     "profileAttributes.businessId": "b4a0cb14-84af-4549-ba36-2e9ad4a98ac0",     "profileAttributes.emailAddress": "john.smith@actito.com",     "scenarioExecutionContextAttributes.startEventType": "CUSTOM_TABLE#NEW_RECORD",     "scenarioExecutionContextAttributes.startEventId": "e46a7856-3e4d-4a88-baa5-a3d599b30550",     "_links": {       "notifyOK": {         "href": "https://www.actito.com/ca/OK_6946_67617411_4JK5QKY19YGM_54501_aHR0cDovL3d3dy5sdW5jaGdhcmRlbi5iZS9mci9teWx1bmNoZ2FyZGVu"       },       "notifyKO": {         "href": "https://www.actito.com/ca/KO_6946_67617411_4JK5QKY19YGM_54501_aHR0cDovL3d3dy5sdW5ds4d45sfJFJ5iZS9mci9teWx1bmNoZ2FyZGVu"       },       "customAction": {         "href": "/v5/entities/MyEntity/custom-actions/123456"       }     }   },   {     "actionParameters.campaignId": "987654",     "actionParameters.campaignGroup": "Notifications",     "profileAttributes.businessId": "4f5427b0-0134-4f4b-971a-98a9f03d0ff5",     "profileAttributes.emailAddress": "jane.smith@actito.com",     "scenarioExecutionContextAttributes.startEventType": "CUSTOM_TABLE#NEW_RECORD",     "scenarioExecutionContextAttributes.startEventId": "c9152856-856e-41ff-9a89-1c7da05e1f76",     "_links": {       "notifyOK": {         "href": "https://www.actito.com/ca/OK_6946_67617412_4JK5QKY19YGM_54501_aHR0cDovL3d3dy5sdW5jaGdhcmRlbi5iZS9mci9teWx1bmNoZ2FyZGVu"       },       "notifyKO": {         "href": "https://www.actito.com/ca/KO_6946_67617412_4JK5QKY19YGM_54501_aHR0cDovL3d3dy5sdW5ds4d45sfJFJ5iZS9mci9teWx1bmNoZ2FyZGVu"       },       "customAction": {         "href": "/v5/entities/MyEntity/custom-actions/123456"       }     }   } ], "_links": {   "webhook": {     "href": "/v4/entity/MyEntity/webhookSubscription/123987456"   } }}

File reference synchronizations#

Trigger event : All triggered event for file reference with id 123456

ONE_BY_ONE#

{  "id": "1b4aa5c5-78ca-4d2d-9b54-d737e9b83fbd",  "data": {    "synchronizedFileReference.synchronizationId": "123456",    "synchronizedFileReference.id": "84",    "synchronizedFileReference.synchronizationStatus": "IN_ERROR",    "_links": {      "synchronizedFileReference": {        "href": "/v5/entities/actito/synchronized-file-references/84"      },      "fileSynchronization": {        "href": "/v5/entities/actito/file-synchronizations/123456"      }    }  },  "_links": {    "webhook": {      "href": "/v4/entity/actito/webhookSubscription/84"    }  },  "_audit": {    "createdAt": "2020-08-24T14:34:06+02:00",    "updatedAt": "2020-08-24T14:34:06+02:00"  }}

BULK#

{ "id": "201373e4-22f9-4165-b394-6223b692eebc", "data": [   {     "synchronizedFileReference.synchronizationId": "123456",     "synchronizedFileReference.id": "84",     "synchronizedFileReference.synchronizationStatus": "IN_ERROR",     "_links": {       "synchronizedFileReference": {         "href": "/v5/entities/actito/synchronized-file-references/84"       },       "fileSynchronization": {         "href": "/v5/entities/actito/file-synchronizations/123456"       }     }   },   {     "synchronizedFileReference.synchronizationId": "123457",     "synchronizedFileReference.id": "84",     "synchronizedFileReference.synchronizationStatus": "IN_ERROR",     "_links": {       "synchronizedFileReference": {         "href": "/v5/entities/actito/synchronized-file-references/84"       },       "fileSynchronization": {         "href": "/v5/entities/actito/file-synchronizations/123457"       }     }   } ], "_links": {   "webhook": {     "href": "/v4/entity/MyEntity/webhookSubscription/123987456"   } }}