Notifications

Configuration examples

Email configuration (English and French) using Mandrill

{
    "campaign_name": "Welcome to the conference (Mandrill)",
    "campaign_id": "welcome-to-the-conference-mandrill",
    "experience_id": "developer-conference-2022",
    "object_id": "website",
    "gateway": "mandrill",
    "notification_type": "email",
    "gateway_config": {
        "api_key": "xxx",
    },
    "content": {
        "_default": "en_GB",
        "en_GB": {
            "from_email": "registration@conference.abc.com",
            "from_name": "ABC conference registration",
            "subject_line": "Thanks for registering {{first_name}}",
            "template_html": "https://devconference.s3.amazonaws.com/registration_en.html",
            "template_text": "https://devconference.s3.amazonaws.com/registration_en.txt"
        },
        "fr_FR": {
            "from_email": "registration@conference.abc.com",
            "from_name": "ABC inscription à la conférence",
            "subject_line": "Merci pour votre inscription {{first_name}}",
            "template_html": "https://devconference.s3.amazonaws.com/registration_fr.html",
            "template_text": "https://devconference.s3.amazonaws.com/registration_fr.txt"
        }
    },
    "webhook_url": "https://xpkit.abc.com/callback"
}

Email configuration using Sendgrid's transactional template feature

{
    "campaign_name": "Welcome to the conference (Sendgrid)",
    "campaign_id": "welcome-to-the-conference-sendgrid",
    "experience_id": "developer-conference-2022",
    "object_id": "website",
    "gateway": "sendgrid",
    "notification_type": "email",
    "gateway_config": {
        "api_key": "xxx",
        "uses_transactional_templates": true
    },
    "content": {
        "_default": "en",
        "en": {
            "template_id": "d-xxx"
        }
    },
    "webhook_url": "https://xpkit.abc.com/callback"
}

Email configuration using an SMTP server

{
    "campaign_name": "Welcome to the conference (SMTP)",
    "campaign_id": "welcome-to-the-conference-smtp",
    "experience_id": "developer-conference-2022",
    "object_id": "website",
    "gateway": "smtp",
    "notification_type": "email",
    "gateway_config": {
        "mail_server": "smtp.example.net",
        "mail_port": 587,
        "use_tls": true,
        "use_ssl": false,
        "username": "username",
        "password": "password"
    },
    "content": {
        "_default": "en_GB",
        "en_GB": {
            "from_email": "registration@conference.abc.com",
            "from_name": "ABC conference registration",
            "subject_line": "Thanks for registering {{first_name}}",
            "template_html": "https://devconference.s3.amazonaws.com/registration_en.html",
            "template_text": "https://devconference.s3.amazonaws.com/registration_en.txt"
        }
    },
    "webhook_url": "https://xpkit.abc.com/callback"
}

SMS configuration using SNS

{
    "campaign_name": "Welcome to the conference (SNS)",
    "campaign_id": "welcome-to-the-conference-sns",
    "experience_id": "developer-conference-2022",
    "object_id": "website",
    "gateway": "sns",
    "notification_type": "sms",
    "gateway_config": {
        "aws_access_key_id": "xxx",
        "aws_secret_access_key": "xxx",
        "aws_region_name": "us-east-1"
    },
    "content": {
        "_default": "en",
        "en": {
            "message": "Thanks for registering {{first_name}}"
        }
    },
    "webhook_url": "https://xpkit.abc.com/callback"
}

Notification request examples

Send an email overriding the default templates and subject line

{
    "campaign_id": "welcome-to-the-conference-mandrill",
    "recipient_email": "sarah.jones@abc.com",
    "language": "fr_FR",
    "content": {
        "template": {
            "first_name": "Sarah",
            "last_name": "Jones"
        },
        "attachments": [
            {
                "file1.png": "http://www.bucket.com/file1.png"
            }
        ],
        "template_html": "https://overrides.s3.amazonaws.com/override_fr.html",
        "template_text": "https://overrides.s3.amazonaws.com/override_fr.txt",
        "subject_line": "{{first_name}}, you have now registered!"
    }
}

Send an email in the future using send_at

{
    "campaign_id": "welcome-to-the-conference-sendgrid",
    "recipient_email": "sarah.jones@abc.com",
    "language": "en",
    "content": {
        "template": {
            "first_name": "Sarah",
            "last_name": "Jones"
        }
    },
    "send_at": "2022-12-01T11:00:00+11"
}

Send an SMS

{
    "campaign_id": "welcome-to-the-conference-sns",
    "recipient_phone": "+44123456789",
    "recipient_id": "b0fc813f-c6b5-4334-97d5-153c4fe6053b",
    "language": "en",
    "content": {
        "template": {
            "first_name": "Sarah",
            "last_name": "Jones"
        }
    }
}