Subscribe
sendy.subscribe
ActionEmailconnection required
Calls the Sendy API with the connection's credentials.
Add an address to a Sendy list, or update the subscriber already on it, including any custom field values.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Sendy
- Secret shape
- the Sendy API key, or {"api_key": "…"}
- Config it needs
- base_url, list_id, brand_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
9 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
email The subscriber's email address. | string | Yes | — | email format | ada@example.com |
list_id The Sendy list to act on; overrides the list set on the connection. | string | No | — | — | ZjcRlkKUNPUJU892heoY6Q |
name The subscriber's name. | string | No | — | — | — |
country Two-letter ISO country code recorded against the subscriber. | string | No | — | ≤ 2 characters | AU |
ipaddress The IP address the sign-up came from, recorded against the subscriber. | string | No | — | — | — |
referrer The URL the sign-up came from, recorded against the subscriber. | string | No | — | url format | — |
gdpr Mark the sign-up as GDPR compliant, as Sendy's 'gdpr' parameter does. | boolean | No | false | — | — |
silent Bypass a double opt-in list's confirmation email and subscribe directly. | boolean | No | false | — | — |
custom_fields Custom field values, keyed by the field's personalization tag (a tag of [Birthday,fallback=] is the key 'Birthday'). | object | No | — | — | {"Birthday":"1990-04-01"} |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"country": "AU",
"custom_fields": {
"Birthday": "1990-04-01"
},
"email": "ada@example.com",
"gdpr": false,
"list_id": "ZjcRlkKUNPUJU892heoY6Q",
"silent": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
subscribed True when Sendy accepted the new subscriber. | boolean | — |
status Sendy's own answer: 'true', or 'Already subscribed.' when the address was on the list already. | string | — |
email The address that was subscribed. | string | — |
list_id The list the address was added to. | string | — |
{
"email": "",
"list_id": "",
"status": "",
"subscribed": false
}See Subscribe run in a workflow.
In a technical demo we add the Sendy connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.