Knowledgebase

Module Hooks

These hooks run on the events related to the module actions.
 

AddContactList

It executes when a contact list has been created successfully.

Example Code

<?php
add_hook('AddContactList',1, function($vars) {

	// Your code here

});
 

EditContactList

It executes when a contact list has been edited.

Example Code

<?php
add_hook('EditContactList',1, function($vars) {

	// Your code here

});
 

DeleteContactList

It executes when a contact list has been deleted.

Example Code

<?php
add_hook('DeleteContactList',1, function($vars) {

	// Your code here

});
 

ImportList

It executes when a contact list has been imported.

Example Code

<?php
add_hook('ImportList',1, function($vars) {

	// Your code here

});
 

ExportList

It executes when a contact list has been exported.

Example Code

<?php
add_hook('ExportList',1, function($vars) {

	// Your code here

});
 

AddContact

It executes when a contact has been added.

Example Code

<?php
add_hook('AddContact',1, function($vars) {

	// Your code here

});
 

EditContact

It executes when a contact has been edited.

Example Code

<?php
add_hook('EditContact',1, function($vars) {

	// Your code here

});
 

DeleteContact

It executes when a contact has been deleted.

Example Code

<?php
add_hook('DeleteContact',1, function($vars) {

	// Your code here

});
 

AddCustomField

It executes when a custom field has been added.

Example Code

<?php
add_hook('AddCustomField',1, function($vars) {

	// Your code here

});
 

EditCustomField

It executes when a custom field has been edited.

Example Code

<?php
add_hook('EditCustomField',1, function($vars) {

	// Your code here

});
 

DeleteCustomField

It executes when a custom field has been deleted.

Example Code

<?php
add_hook('DeleteCustomField',1, function($vars) {

	// Your code here

});
 

AddSegment

It executes when a segment has been created.

Example Code

<?php
add_hook('AddSegment',1, function($vars) {

	// Your code here

});
 

DeleteSegment

It executes when a segment has been deleted.

Example Code

<?php
add_hook('DeleteSegment',1, function($vars) {

	// Your code here

});
 

RecountSegment

It executes when a segment has been recounted.

Example Code

<?php
add_hook('RecountSegment',1, function($vars) {

	// Your code here

});
 

ExportSegment

It executes when a segment has been exported.

Example Code

<?php
add_hook('ExportSegment',1, function($vars) {

	// Your code here

});
 

AddBroadcast

It executes when a broadcast has been added.

Example Code

<?php
add_hook('AddBroadcast',1, function($vars) {

	// Your code here

});
 

EditBroadcast

It executes when a broadcast has been edited.

Example Code

<?php
add_hook('EditBroadcast',1, function($vars) {

	// Your code here

});
 

DeleteBroadcast

It executes when a broadcast has been deleted.

Example Code

<?php
add_hook('DeleteBroadcast',1, function($vars) {

	// Your code here

});
 

AddDripGroup

It executes when a drip group has been added.

Example Code

<?php
add_hook('AddDripGroup',1, function($vars) {

	// Your code here

});
 

EditDripGroup

It executes when a drip group has been edited.

Example Code

<?php
add_hook('EditDripGroup',1, function($vars) {

	// Your code here

});
 

DeleteDripGroup

It executes when a drip group has been deleted.

Example Code

<?php
add_hook('DeleteDripGroup',1, function($vars) {

	// Your code here

});
 

AddDrip

It executes when a drip has been added.

Example Code

<?php
add_hook('AddDrip',1, function($vars) {

	// Your code here

});
 

EditDrip

It executes when a drip has been edited.

Example Code

<?php
add_hook('EditDrip',1, function($vars) {

	// Your code here

});
 

DeleteDrip

It executes when a drip has been deleted.

Example Code

<?php
add_hook('DeleteDrip',1, function($vars) {

	// Your code here

});
 

AddSplitTest

It executes when a split test has been created.

Example Code

<?php
add_hook('AddSplitTest',1, function($vars) {

	// Your code here

});
 

EditSplitTest

It executes when a split test has been edited.

Example Code

<?php
add_hook('EditSplitTest',1, function($vars) {

	// Your code here

});
 

DeleteSplitTest

It executes when a split test has been deleted.

Example Code

<?php
add_hook('DeleteSplitTest',1, function($vars) {

	// Your code here

});
 

AddSpinTag

It executes when a spintag has been added.

Example Code

<?php
add_hook('AddSpinTag',1, function($vars) {

	// Your code here

});
 

EditSpingTag

It executes when a spintag has been edited.

Example Code

<?php
add_hook('EditSpingTag',1, function($vars) {

	// Your code here

});
 

DeleteSpinTag

It executes when a spintag has been deleted.

Example Code

<?php
add_hook('DeleteSpinTag',1, function($vars) {

	// Your code here

});
 

AddDynamicContentTag

It executes when a dynamic content tag has been added.

Example Code

<?php
add_hook('AddDynamicContentTag',1, function($vars) {

	// Your code here

});
 

EditDynamicContentTag

It executes when a dynamic content tag has been edited.

Example Code

<?php
add_hook('EditDynamicContentTag',1, function($vars) {

	// Your code here

});
 

DeleteDynamicContentTag

It executes when a dynamic content tag has been deleted.

Example Code

<?php
add_hook('DeleteDynamicContentTag',1, function($vars) {

	// Your code here

});
 

ScheduleBroadcast

It executes when a broadcast has been scheduled.

Example Code

<?php
add_hook('ScheduleBroadcast',1, function($vars) {

	// Your code here

});
 

RescheduleBroadcast

It executes when a broadcast has been re-scheduled.

Example Code

<?php
add_hook('RescheduleBroadcast',1, function($vars) {

	// Your code here

});
 

StartBroadcast

It executes when a broadcast is started.

Example Code

<?php
add_hook('StartBroadcast',1, function($vars) {

	// Your code here

});
 

PauseBroadcast

It executes when a broadcast is paused.

Example Code

<?php
add_hook('PauseBroadcast',1, function($vars) {

	// Your code here

});
 

SystemPauseBroadcast

It executes when a broadcast is system-paused.

Example Code

<?php
add_hook('SystemPauseBroadcast',1, function($vars) {

	// Your code here

});
 

CompleteBroadcast

It executes when a broadcast is completed.

Example Code

<?php
add_hook('CompleteBroadcast',1, function($vars) {

	// Your code here

});
 

ResumeBroadcast

It executes when a broadcast is resumed.

Example Code

<?php
add_hook('ResumeBroadcast',1, function($vars) {

	// Your code here

});
 

DeleteScheduledBroadcast

It executes when a scheduled broadcast is deleted.

Example Code

<?php
add_hook('DeleteScheduledBroadcast',1, function($vars) {

	// Your code here

});
 

AddTrigger

It executes when a trigger is added.

Example Code

<?php
add_hook('AddTrigger',1, function($vars) {

	// Your code here

});
 

EditTrigger

It executes when a trigger is edited.

Example Code

<?php
add_hook('EditTrigger',1, function($vars) {

	// Your code here

});
 

DeleteTrigger

It executes when a trigger is deleted.

Example Code

<?php
add_hook('DeleteTrigger',1, function($vars) {

	// Your code here

});
 

ResortTriggers

It executes when the triggers are re-sorted.

Example Code

<?php
add_hook('ResortTriggers',1, function($vars) {

	// Your code here

});
 

AddBounceAddress

It executes when a bounce address is added.

Example Code

<?php
add_hook('AddBounceAddress',1, function($vars) {

	// Your code here

});
 

EditBounceAddress

It executes when a bounce address is edited.

Example Code

<?php
add_hook('EditBounceAddress',1, function($vars) {

	// Your code here

});
 

DeleteBounceAddress

It executes when a bounce address is deleted.

Example Code

<?php
add_hook('DeleteBounceAddress',1, function($vars) {

	// Your code here

});
 

AddBounceRule

It executes when a bounce rule is added.

Example Code

<?php
add_hook('AddBounceRule',1, function($vars) {

	// Your code here

});
 

EditBounceRule

It executes when a bounce rule is edited.

Example Code

<?php
add_hook('EditBounceRule',1, function($vars) {

	// Your code here

});
 

DeleteBounceRule

It executes when a bounce rule is deleted.

Example Code

<?php
add_hook('DeleteBounceRule',1, function($vars) {

	// Your code here

});
 

ResortBounceRule

It executes when the bounce rules are re-sorted.

Example Code

<?php
add_hook('ResortBounceRule',1, function($vars) {

	// Your code here

});
 

AddSendingDomain

It executes when a sending domain is added.

Example Code

<?php
add_hook('AddSendingDomain',1, function($vars) {

	// Your code here

});

 

EditSendingDomain

It executes when a sending domain is edited.

Example Code

<?php
add_hook('EditSendingDomain',1, function($vars) {

	// Your code here

});
 

DeleteSendingDomain

It executes when a sending domain is deleted.

Example Code

<?php
add_hook('DeleteSendingDomain',1, function($vars) {

	// Your code here

});
 

AddSendingNode

It executes when a sending node is added.

Example Code

<?php
add_hook('AddSendingNode',1, function($vars) {

	// Your code here

});
 

EditSendingNode

It executes when a sending node is edited.

Example Code

<?php
add_hook('EditSendingNode',1, function($vars) {

	// Your code here

});
 

DeleteSendingNode

It executes when a sending node is deleted.

Example Code

<?php
add_hook('DeleteSendingNode',1, function($vars) {

	// Your code here

});
 

AddWebForm

It executes when a web form is added.

Example Code

<?php
add_hook('AddWebForm',1, function($vars) {

	// Your code here

});
 

EditWebForm

It executes when a web form is edited.

Example Code

<?php
add_hook('EditWebForm',1, function($vars) {

	// Your code here

});
 

DeleteWebForm

It executes when a web form is deleted.

Example Code

<?php
add_hook('DeleteWebForm',1, function($vars) {

	// Your code here

});
 

AddFeebackLoop

It executes when a feedback loop is added.

Example Code

<?php
add_hook('AddFeebackLoop',1, function($vars) {

	// Your code here

});
 

EditFeebackLoop

It executes when a feedback loop is edited.

Example Code

<?php
add_hook('EditFeebackLoop',1, function($vars) {

	// Your code here

});
 

DeleteFeebackLoop

It executes when a feedback loop is deleted.

Example Code

<?php
add_hook('DeleteFeebackLoop',1, function($vars) {

	// Your code here

});
 

AfterCron

It executes after the cronjob runs.

Example Code

<?php
add_hook('AfterCron',1, function($vars) {

	// Your code here

});