This document is for an older version of
Freeform
.
View latest version →
Developer
CRM Integration Events
Use these events to extend the functionality of Freeform CRM Integrations:
Before data is pushed to the CRM
Use this event to manipulate the data that is about to be pushed to the CRM.
use Solspace\Freeform\Services\CrmService;
use Solspace\Freeform\Events\Integrations\PushEvent;
Event::on(
CrmService::class,
CrmService::EVENT_BEFORE_PUSH,
function (PushEvent $event) {
$integration = $event->getIntegration();
$values = $event->getValues();
// Only perform this for the "My Salesforce Intagration" integration
if ($integration->getName() === 'My Salesforce Integration') {
// Manually add a desired value for "customSalesforceField" field in Salesforce
// This value will be pushed along with the rest to the CRM integration
$event->addValue('customSalesforceField', 1234);
}
}
)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
After data has been pushed to the CRM
This event allows you to do something right after data has been pushed to the CRM.
WARNING
This event does not contain the response that was received from the CRM. Use the After Response event for that.
use Solspace\Freeform\Services\CrmService;
use Solspace\Freeform\Events\Integrations\PushEvent;
Event::on(
CrmService::class,
CrmService::EVENT_AFTER_PUSH,
function (PushEvent $event) {
$integration = $event->getIntegration();
$values = $event->getValues();
// Perform some actions here
}
)
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
After the response from the CRM was received
This event contains the Guzzle Response object of the response received after pushing the data to the CRM. Use this to perform other calls to other API endpoints, for instance - relating the created object's ID to some other object in the CRM.
use Solspace\Freeform\Services\CrmService;
use Solspace\Freeform\Events\Integrations\IntegrationResponseEvent;
Event::on(
CrmService::class,
CrmService::EVENT_AFTER_RESPONSE,
function (IntegrationResponseEvent $event) {
$integration = $event->getIntegration();
$response = $event->getResponse(); // instance of \Psr\Http\Message\ResponseInterface
$responseAsString = $event->getResponseBodyAsString(); // Usually a stringified JSON object
// Perform some actions here
}
)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
Before saving an integration
use Solspace\Freeform\Services\CrmService;
use Solspace\Freeform\Events\Integrations\SaveEvent;
Event::on(
CrmService::class,
CrmService::EVENT_BEFORE_SAVE,
function (SaveEvent $event) {
$integrationModel = $event->getModel();
$isNew = $event->isNew();
// Perform some actions here
}
)
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
After saving an integration
use Solspace\Freeform\Services\CrmService;
use Solspace\Freeform\Events\Integrations\SaveEvent;
Event::on(
CrmService::class,
CrmService::EVENT_AFTER_SAVE,
function (SaveEvent $event) {
$integrationModel = $event->getModel();
$isNew = $event->isNew();
// Perform some actions here
}
)
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
Before deleting an integration
use Solspace\Freeform\Services\CrmService;
use Solspace\Freeform\Events\Integrations\DeleteEvent;
Event::on(
CrmService::class,
CrmService::EVENT_BEFORE_DELETE,
function (DeleteEvent $event) {
$integrationModel = $event->getModel();
// Perform some actions here
}
)
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
After deleting an integration
use Solspace\Freeform\Services\CrmService;
use Solspace\Freeform\Events\Integrations\DeleteEvent;
Event::on(
CrmService::class,
CrmService::EVENT_AFTER_DELETE,
function (DeleteEvent $event) {
$integrationModel = $event->getModel();
// Perform some actions here
}
)
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12