Email Automation Service Documentation

The Email Automation Service provides seamless integration between ICE Policy, Customer Portal, and Salesforce, ensuring efficient and reliable communication with customers.

Endpoints

Notify Endpoints

These endpoints are used to handle notifications across different environments.

• UAT: https://us-central1-ice-portal-uat.cloudfunctions.net/notify

• Prelive: https://us-central1-ice-portal-prelive.cloudfunctions.net/notify

• Live: https://notify-ice.insyncdigital.co.uk/notify

Usage

All endpoints accept POST requests containing event payloads from ICE Policy. These requests should adhere to the specified schema detailed below.

Event Types

Below is the list of ICE Policy events processed by the Email Automation Service:

1. MTA_ACCEPTED

2. CANCELLATION_TRANSACTION_ACCEPTED

3. REINSTATEMENT_TRANSACTION_ACCEPTED

4. RENEWAL_ACCEPT_ACCEPTED

5. RENEWAL_INVITE_ACCEPTED

6. QAB_QUOTE_ISSUED

7. QUOTE_ISSUED

8. RENEWAL_INVITE_INVITED

9. PENDING_RENEWAL_INVITE_CREATED

10. TRANSACTION_EXPIRED

11. QAB_QUOTE_EDIT

12. QAB_QUOTE_RATED

13. NEW_BUSINESS_ACCEPTED

These event types trigger appropriate workflows such as email notifications, Salesforce updates, and Customer Portal actions.

Schema

Example Payload for QUOTE_ISSUED Event: The service processes events based on a defined schema. Below is an example of the payload structure for the QUOTE_ISSUED event:

{
    "eventId": "ID:ice-policy-0-44105-1702300261254-1:1:1021:1:3",
    "eventType": "QUOTE_ISSUED",
    "value": {
        "quoteMetadata": {
            "@type": "QuoteMetadata",
            "product": "STAC",
            "productVersionCode": "STAC_#1",
            "scheme": "STAC",
            "schemeVersionCode": "STAC_#1",
            "termStartDate": "2024-01-06T00:00:00Z",
            "termEndDate": "2025-01-05T23:59:59Z",
            "transactionType": "QUOTE",
            "quoteRef": "STAC00034572.1",
            "quoteState": "ISSUED",
            "transactionStatus": "ISSUED"
        },
        "transactionMetadata": {
            "createdDate": "2024-01-25T11:05:50.307Z",
            "salesChannel": "DIRECT"
        }
    },
    "eventTimestamp": 1706180781797
}

Key Attributes:

• eventId: A unique identifier for the event.

• eventType: Type of event (e.g., QUOTE_ISSUED).

• value: Detailed metadata about the quote, including product, scheme, and transaction details.

• eventTimestamp: The timestamp when the event was generated.

For other event types, the payload structure may vary slightly. Ensure that all mandatory fields are present when sending data to the notify endpoints.