Integrations of the Emarsys Marketing Platform can be enabled per Emarsys customer account. When the integration is installed or uninstalled, our platform can report these events to the integration via HTTP calls. It also passes relevant customer information optionally. Based on these, the integration can set up users or perform other administration tasks.
HTTP Interfaces
Below we describe the HTTP interface which the integration can implement.
Installation
This should be considered as a post install hook. The request is sent to the provided endpoint of the add-on after the turn-on procedure is finished on Emarsys side.
- The integration installation URL is provided by the add-on provider (during the set-up process).
- We do not send the environment, as it should not be used by the add-on.
- The only mandatory parameter we send is the
customer_id.
Endpoint
POST <integration_installation_url>
Parameters
| Name | Type | Description |
|---|---|---|
| customer_id | int | The ID of the customer (mandatory). |
| configuration | hash | Integration-specific data (based on the integration needs). |
Request Example
POST https://emarsys.partnerservice.com/api/install
{
"customer_id": 111111111,
"configuration": {}
}
Removal
This endpoint can be implemented by the integration; it is called when the integration is removed in the Emarsys application.
- We also do not send the environment, only the
customer ID.
Endpoint
DELETE <integration_removal_url>/<customerId>
Parameters
| Name | Type | Description |
|---|---|---|
| customer_Id | int | The ID of the customer (mandatory). |
Request example
DELETE <integration_removal_url>/<customerId>