Newsletter Subscriptions

This guide explains how to integrate a custom newsletter subscription service into SCAYLE's Checkout. By following the steps, you can:

• Determine if a customer is already subscribed
• Handle subscription status updates

Prerequisites

Before you begin, you need to build the following components:

• Middleware to check subscription status and handle the subscription webhook.
• An HTTP endpoint that can receive subscription status requests and respond accordingly.
• Configuration in the SCAYLE Panel to enable the subscription check and webhook handling.

Integration Flow

Build Newsletter Subscription Check Endpoint

You need to provide an HTTP service that:

• Can handle the usual load of your shop.
• Accepts requests from SCAYLE networks.

Endpoint Specification

• Method: GET

Headers

• Authorization: Basic auth (credentials need to be added to the Newsletter Subscription Configuration).
• X-Shop-Id: The current shop-country ID.

Query Parameters

Response

• Status Codes:
  • 200 – Subscription status in response body
  • 401 – Authentication failed
  • 404 – Subscription not found

Response Body Example

json

Copy

{
  "status": "subscribed"
}

Status Descriptions

OpenAPI Specification

An example OpenAPI specification that can be customized is available for download:

Download Newsletter-Subscription-API.yaml

Configure Subscription Check Endpoint in SCAYLE

The Subscription Check Endpoint Configuration can be set via the SCAYLE Panel:

1. Go to Settings ➜ Imports & Jobs ➜ Imports.
2. Create a new Shop Import inside Checkout Configurations.
3. Provide the following Field as configuration_key file and upload the configuration:
   1. newsletter.subscriptionCheck.password
   2. newsletter.subscriptionCheck.username
   3. newsletter.subscriptionCheckEndpoint.endpoint

Create a Newsletter-Subscribed Webhook

You can create a newsletter-subscribed webhook in the SCAYLE Panel:

1. Go to Settings ➜ Webhooks ➜ Admin Webhooks.
2. Enter the following:
   • Version – For example: 1
   • Event Name – Select newsletter-subscribed
   • URL – The URL that will be called when the webhook is triggered
3. Click SAVE

Alternatively, you can add a newsletter-subscribed webhook using the Admin API.

Enable Subscription Checkbox on the Frontend

1. Go to Settings ➜ Checkout ➜ Configurations.
2. Navigate to Dynamic Field ➜ Payment Options and Enable Area.
3. Create a new checkbox field:
   • Name: newsletterSignUp
4. Save the configuration.

The subscription checkbox is now enabled in the checkout frontend.