Vendor integration other than supported vendors
If you want to use a vendor other than Capillary’s vendor, you have to integrate the new vendor into the system.
Prerequisites:
- Create a relay or integration ticket with the PST team to add the new vendor in the backend.
- Create a ticket for the PST team to get the Webhook URL and Service URL.
- Obtain the API key from the vendor.
- Obtain the username and password from either the Gateway team or the vendor.
Steps to integrate a new vendor
-
In the desired cluster (for example, the EU cluster), navigate to Organization Settings of the Capillary Technologies organization.
-
Select Communication & Gateway > Domains > Domain Gateway Mapping.
- Select +Domain-Gateway Mapping and provide the following details:
| Field | Description |
|---|---|
| Domain | The default domain used in the system. For example, capillary.co.in, which is already configured in the Configure Domains section.. |
| SMS Map Name | A reference name to identify the sender Id. The naming format is vendorname_cluster/brandname_Bulk or brandname_Transactional. For example: phalcon_adidas/eu_bulk. |
| Gateway Vendor | The third-party providers connected with Capillary for sending messages through channels such as email, SMS, and WhatsApp. |
| Hostname | Not applicable. |
| Short Name | A shortened label for the domain, usually the same as the Subdomain value. |
| Username and Password | The credentials required to establish a secure connection between Capillary and the vendor, provided by the Gateway team or the vendor. |
| Connection Properties | The authentication and communication details used to connect with the vendor. It includes: • API key – Obtained from the vendor. It is used to authenticate Capillary’s system with the vendor for secure email delivery. • Webhook URL – Provided by the PST team. Used for communication between Capillary and the vendor (for example, to receive delivery status updates or callbacks). Example: {“dlrurl”:“https://dlr.eucrm.cc.capillarytech.com/solutionsbulk”, “apiKey”:“Aad7f6e74ad57cd98e331ec2fc1f0547f”} |
| Service Ip | Null by default. |
| Service Url | The endpoint used to connect Capillary with the vendor’s system to process messages. This is provided by the PST team. |
| StatusCheck Url | The endpoint used to retrieve or receive delivery status reports from the vendor. This is provided by the PST team. |
| Channel Count | The number of batches into which the email audience is split. For example, if the audience size is 1,000 and the value is 5, then 200 emails are sent in each batch. |
| Status | Indicates whether the vendor integration is enabled (Active) or disabled (Not Active). This should always be set to Active. |
| Status Check Type | Defines how delivery reports are obtained from the vendor. Options available : - Pull (default): The system pulls delivery status (reports) from the vendor’s API. - Push: Some vendors send delivery reports to Capillary through a post call instead of pulling. |
| Start Date | Date when the integration begins. Note: The vendor integration is active 24 hours after the start date. |
| End Date | Date when the integration expires. |
- Save the configuration.
The new vendor is now integrated into the Capillary system for the brand.
Updated about 13 hours ago