Ewity calls this first, the moment the merchant opens the Connect modal on the Ecommerce Platforms page — before they have a code. Your response is rendered above the connect-code input and is the merchant's primary set of instructions for how to generate a code on your side. They read it, follow the steps in your dashboard, then come back to paste the code.
This endpoint is strongly recommended but not strictly required. If we get any non-200 response (or no response at all), we fall back to generic copy ("Generate a connection code on {platform name} and paste it here…"). That fallback works only if your platform has an obvious "Connect to Ewity" entry point — if it doesn't, the merchant won't know where to look. Implement this endpoint.
Request
GET {your_connect_url} HTTP/1.1
Authorization: Bearer {your_shared_platform_auth_token}
Accept: application/jsonNo body. No query parameters.
Response — 200
{
"instructions": "1. Log in to your Online Order MV dashboard.\n2. Open Settings → Integrations → Ewity.\n3. Click **Generate Connection Code** and paste it below.",
"code_label": "Online Order MV Code"
}| Field | Type | Required | Notes |
|---|---|---|---|
instructions | string | yes | Markdown-flavoured plain text. Newlines are preserved when rendered. Keep it short — ideally under 4 lines. |
code_label | string | no | Overrides the input label in the modal. Defaults to "Connection code" if omitted. |
Response — 4xx / 5xx
Any error response (or a malformed body) causes Ewity to silently fall back to generic copy. Returning errors here doesn't break the merchant flow — it just means they see less-specific instructions.
Notes
- We hit this endpoint each time the merchant opens the modal. If you want to A/B different copy or change wording, you can do it from your side without involving us.
- Don't put secrets, links to login screens, or anything sensitive in
instructions— the merchant is already authenticated on Ewity, but treat the rendered output as untrusted plain text on our side.