> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/sendpulse.md).

# SendPulse

Send transactional email, run email, SMS, and web push campaigns, and manage mailing lists through SendPulse.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector           | Authentication |
| ------------------- | -------------- |
| SendPulse           | Credentials    |
| SendPulse (API Key) | API Key        |

### SendPulse

Connect to SendPulse with an API ID and secret to send email, SMS, and web push, run campaigns, and manage mailing lists.

#### Set up in SendPulse

1. Prepare the SendPulse account or service that the workflow will access. Grant access to the required resources and operations.
2. **API ID:** Create an API ID and secret in SendPulse under Account Settings > API, then paste the API ID here.
3. **API Secret:** The API secret paired with the API ID above, from Account Settings > API.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **SendPulse**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                       |
| ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API ID        | Yes      | Create an API ID and secret in SendPulse under Account Settings > API, then paste the API ID here. [Provider instructions](https://sendpulse.com/integrations/api). |
| API Secret    | Yes      | The API secret paired with the API ID above, from Account Settings > API. [Provider instructions](https://sendpulse.com/integrations/api).                          |

### SendPulse (API Key)

Connect to SendPulse with a static account API key to send email, SMS, and web push, run campaigns, and manage mailing lists.

#### Set up in SendPulse

1. Prepare the SendPulse account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Generate an API key in SendPulse under Account Settings > API, then paste it here.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **SendPulse (API Key)**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                       |
| ------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes      | Generate an API key in SendPulse under Account Settings > API, then paste it here. [Provider instructions](https://sendpulse.com/integrations/api). |

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **SendPulse** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Add Contacts to Mailing List

Add one or more email addresses to a SendPulse mailing list, optionally with personalisation variables.

#### Inputs

| Field                     | Type            | Required | Description                                                                                                                               |
| ------------------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Mailing List              | select (string) | Yes      | The mailing list the contacts are added to. Options load from the selected connection.                                                    |
| Email Addresses           | string          | Yes      | Email addresses to add, separated by commas.                                                                                              |
| Personalisation Variables | textarea        | No       | Merge-field values applied to every contact added in this call, as JSON.                                                                  |
| Opt-in Type               | select (string) | No       | Whether contacts are added straight away or must confirm by email first. Available values: Single opt-in, Double opt-in. Default: single. |
| Confirmation Sender       | select (string) | No       | Verified sender address the double opt-in confirmation email is sent from. Options load from the selected connection.                     |

#### Outputs

| Field               | Type    | Description                                     |
| ------------------- | ------- | ----------------------------------------------- |
| Success             | boolean | Whether SendPulse accepted the addresses.       |
| Addresses Submitted | integer | How many addresses were submitted in this call. |
| Mailing List ID     | string  | The mailing list the contacts were added to.    |

### Create Mailing List

Create a new, empty SendPulse mailing list.

#### Inputs

| Field     | Type   | Required | Description                            |
| --------- | ------ | -------- | -------------------------------------- |
| List Name | string | Yes      | Name shown for this list in SendPulse. |

#### Outputs

| Field           | Type   | Description                   |
| --------------- | ------ | ----------------------------- |
| Mailing List ID | string | Id of the newly created list. |
| List Name       | string | Name of the created list.     |

### List Mailing Lists

List the SendPulse mailing lists in the account, with subscriber counts.

#### Inputs

| Field         | Type    | Required | Description                                                             |
| ------------- | ------- | -------- | ----------------------------------------------------------------------- |
| Maximum Lists | integer | No       | How many mailing lists to return. Default: 25.                          |
| Start From    | integer | No       | Skip this many lists before reading, for paging through a long account. |

#### Outputs

| Field         | Type          | Description                                                     |
| ------------- | ------------- | --------------------------------------------------------------- |
| Mailing Lists | object\_array | The mailing lists found.                                        |
| Next Offset   | integer       | Where the next page starts; empty when there are no more lists. |

### List Contacts in Mailing List

Read the contacts in a SendPulse mailing list, with their status and variables.

#### Inputs

| Field               | Type            | Required | Description                                                                                                             |
| ------------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------- |
| Mailing List        | select (string) | Yes      | The mailing list to read contacts from. Options load from the selected connection.                                      |
| Maximum Contacts    | integer         | No       | How many contacts to return. Default: 25.                                                                               |
| Subscription Status | select (string) | No       | Return everyone, only active subscribers, or only inactive ones. Available values: All, Active, Inactive. Default: all. |
| Start From          | integer         | No       | Skip this many contacts before reading, for paging through a large list.                                                |

#### Outputs

| Field       | Type          | Description                                                          |
| ----------- | ------------- | -------------------------------------------------------------------- |
| Contacts    | object\_array | The contacts found in the list.                                      |
| Next Offset | integer       | Where the next page starts; empty when the whole list has been read. |

### Find Contact

Check which SendPulse mailing lists an email address belongs to.

#### Inputs

| Field         | Type   | Required | Description                   |
| ------------- | ------ | -------- | ----------------------------- |
| Email Address | string | Yes      | The email address to look up. |

#### Outputs

| Field         | Type          | Description                                      |
| ------------- | ------------- | ------------------------------------------------ |
| Found         | boolean       | Whether the address belongs to any mailing list. |
| Email Address | string        | The address that was looked up.                  |
| Mailing Lists | object\_array | The mailing lists this address belongs to.       |

### Unsubscribe Contacts

Mark email addresses as unsubscribed in a SendPulse mailing list so they stop receiving campaigns.

#### Inputs

| Field           | Type            | Required | Description                                                                                     |
| --------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------- |
| Mailing List    | select (string) | Yes      | The mailing list the contacts are unsubscribed from. Options load from the selected connection. |
| Email Addresses | string          | Yes      | Email addresses to unsubscribe, separated by commas.                                            |

#### Outputs

| Field                  | Type    | Description                                            |
| ---------------------- | ------- | ------------------------------------------------------ |
| Success                | boolean | Whether SendPulse accepted the unsubscribe.            |
| Addresses Unsubscribed | integer | How many addresses were submitted for unsubscribe.     |
| Mailing List ID        | string  | The mailing list the addresses were unsubscribed from. |

### Create Email Campaign

Send or schedule an email campaign to a SendPulse mailing list.

#### Inputs

| Field         | Type            | Required | Description                                                                                                                            |
| ------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| From Address  | select (string) | Yes      | Verified sender address the campaign is sent from. Options load from the selected connection.                                          |
| From Name     | string          | Yes      | Name recipients see as the sender.                                                                                                     |
| Subject       | string          | Yes      | Subject line of the campaign email.                                                                                                    |
| Mailing List  | select (string) | Yes      | The mailing list that receives the campaign. Options load from the selected connection.                                                |
| Content From  | select (string) | No       | Write the email as HTML here, or use a template saved in SendPulse. Available values: Write HTML, Use a saved template. Default: html. |
| HTML Content  | textarea        | No       | The email body as HTML.                                                                                                                |
| Template      | select (string) | No       | A template already saved in SendPulse. Options load from the selected connection.                                                      |
| Campaign Name | string          | No       | Internal name for this campaign in SendPulse reports.                                                                                  |
| Send At       | datetime        | No       | Schedule the campaign instead of sending it right away.                                                                                |
| Save as Draft | boolean         | No       | Create the campaign without sending it, so someone can review it in SendPulse first. Default: false.                                   |
| Track Opens   | boolean         | No       | Record when recipients open the email. Default: true.                                                                                  |
| Track Clicks  | boolean         | No       | Record when recipients click links in the email. Default: true.                                                                        |

#### Outputs

| Field          | Type    | Description                                |
| -------------- | ------- | ------------------------------------------ |
| Campaign ID    | string  | Id of the created campaign.                |
| Status         | integer | SendPulse status code for the campaign.    |
| Recipients     | integer | How many contacts the campaign will reach. |
| Emails Charged | integer | Emails deducted from the account balance.  |

### Get Campaign Report

Read the delivery and engagement results of a SendPulse email campaign.

#### Inputs

| Field    | Type            | Required | Description                                                           |
| -------- | --------------- | -------- | --------------------------------------------------------------------- |
| Campaign | select (string) | Yes      | The campaign to report on. Options load from the selected connection. |

#### Outputs

| Field              | Type          | Description                                                     |
| ------------------ | ------------- | --------------------------------------------------------------- |
| Campaign ID        | string        | Id of the campaign reported on.                                 |
| Campaign Name      | string        | Internal name of the campaign.                                  |
| Subject            | string        | Subject line recipients saw.                                    |
| Status             | integer       | SendPulse status code for the campaign.                         |
| Send Date          | string        | When the campaign was sent.                                     |
| Recipients         | integer       | Total recipients of the campaign.                               |
| Web Version Link   | string        | Public archive link to the sent email.                          |
| Delivery Breakdown | object\_array | How many recipients were delivered, opened, clicked or errored. |
| Link Clicks        | object\_array | Click counts per link in the email.                             |

### Send Transactional Email

Send a one-off email such as a receipt, alert or password reset through SendPulse SMTP.

#### Inputs

| Field              | Type            | Required | Description                                                                                |
| ------------------ | --------------- | -------- | ------------------------------------------------------------------------------------------ |
| From Address       | select (string) | Yes      | Verified sender address the email is sent from. Options load from the selected connection. |
| From Name          | string          | Yes      | Name recipients see as the sender.                                                         |
| To                 | string          | Yes      | Recipient email addresses, separated by commas.                                            |
| Subject            | string          | Yes      | Subject line of the email.                                                                 |
| HTML Content       | textarea        | Yes      | The email body as HTML.                                                                    |
| Plain Text Content | textarea        | No       | Plain-text version for clients that do not render HTML.                                    |
| Attachment URLs    | string          | No       | Links to files to attach; each one is downloaded and attached to the email.                |
| CC                 | string          | No       | Addresses to copy, separated by commas.                                                    |
| BCC                | string          | No       | Addresses to blind-copy, separated by commas.                                              |
| Reply-To           | string          | No       | Address replies should go to, if different from the sender.                                |

#### Outputs

| Field      | Type    | Description                                        |
| ---------- | ------- | -------------------------------------------------- |
| Success    | boolean | Whether SendPulse accepted the email for delivery. |
| Message ID | string  | SendPulse id for the sent message.                 |

### Send SMS

Send an SMS to specific phone numbers or to everyone on a SendPulse mailing list.

#### Inputs

| Field             | Type            | Required | Description                                                                                                                             |
| ----------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| Sender Name       | select (string) | Yes      | The approved sender name recipients see. Options load from the selected connection.                                                     |
| Send To           | select (string) | No       | Send to specific numbers, or to every number on a mailing list. Available values: Phone numbers, Mailing list. Default: phone\_numbers. |
| Phone Numbers     | string          | No       | Phone numbers in international format, separated by commas.                                                                             |
| Mailing List      | select (string) | No       | The mailing list whose phone numbers receive the SMS. Options load from the selected connection.                                        |
| Message           | textarea        | Yes      | The text of the SMS.                                                                                                                    |
| Send At           | datetime        | No       | Schedule the SMS instead of sending it right away.                                                                                      |
| Track Link Clicks | boolean         | No       | Rewrite links in the message so clicks are counted. Default: false.                                                                     |

#### Outputs

| Field           | Type    | Description                             |
| --------------- | ------- | --------------------------------------- |
| Success         | boolean | Whether SendPulse accepted the SMS.     |
| SMS Campaign ID | string  | Id SendPulse assigned to this SMS send. |
| Recipients      | integer | How many numbers the SMS was sent to.   |

### Send Web Push Notification

Send a browser push notification to the subscribers of a SendPulse push website.

#### Inputs

| Field         | Type            | Required | Description                                                                                                     |
| ------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
| Website       | select (string) | Yes      | The push-enabled website whose subscribers receive the notification. Options load from the selected connection. |
| Title         | string          | Yes      | Headline shown in the notification.                                                                             |
| Message       | textarea        | Yes      | Body text of the notification.                                                                                  |
| Link          | string          | No       | Page opened when someone clicks the notification.                                                               |
| Expires After | integer         | No       | How long the notification stays deliverable to subscribers who are offline.                                     |
| Send At       | datetime        | No       | Schedule the notification instead of sending it right away.                                                     |

#### Outputs

| Field            | Type    | Description                                  |
| ---------------- | ------- | -------------------------------------------- |
| Success          | boolean | Whether SendPulse accepted the notification. |
| Push Campaign ID | string  | Id SendPulse assigned to this push campaign. |

## Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

### On Email Event

Starts the workflow when SendPulse reports an email engagement or delivery event, such as an open, click, bounce or unsubscribe.

StackAI registers a webhook with SendPulse for the event types you select below; no manual setup is needed in the SendPulse dashboard. 1. Choose which **Event Types** should start this workflow (delivered, opened, clicked, ...). 2. Optionally restrict to a single **Mailing List**. 3. Publish the trigger. SendPulse will start sending matching events to StackAI.

#### Configuration

| Field                  | Type                      | Required | Description                                                                                                                                               |
| ---------------------- | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Event Types            | multiple\_select (string) | Yes      | Which email events should start this workflow. Available values: Delivered, Opened, Link Clicked, Marked as Spam, Unsubscribed, Hard Bounce, Soft Bounce. |
| Only This Mailing List | select (string)           | No       | Ignore events for contacts outside this mailing list. Options load from the selected connection.                                                          |

#### Event inputs

| Field           | Type   | Required | Description                                                                              |
| --------------- | ------ | -------- | ---------------------------------------------------------------------------------------- |
| Event           | string | Yes      | Which kind of event happened.                                                            |
| Email Address   | string | Yes      | The recipient the event is about.                                                        |
| Occurred At     | string | No       | When SendPulse recorded the event.                                                       |
| Mailing List ID | string | No       | The mailing list the contact belongs to, when SendPulse reports one. Default: .          |
| Campaign ID     | string | No       | The campaign that produced the event, when SendPulse reports one. Default: .             |
| Clicked Link    | string | No       | The link that was clicked, on click events. Default: .                                   |
| Reason          | string | No       | Why the email bounced or the contact unsubscribed, when SendPulse reports it. Default: . |

#### Outputs

| Field           | Type     | Description                                                                   |
| --------------- | -------- | ----------------------------------------------------------------------------- |
| Event           | string   | Which kind of event happened.                                                 |
| Email Address   | string   | The recipient the event is about.                                             |
| Occurred At     | datetime | When SendPulse recorded the event.                                            |
| Mailing List ID | string   | The mailing list the contact belongs to, when SendPulse reports one.          |
| Campaign ID     | string   | The campaign that produced the event, when SendPulse reports one.             |
| Clicked Link    | string   | The link that was clicked, on click events.                                   |
| Reason          | string   | Why the email bounced or the contact unsubscribed, when SendPulse reports it. |

### On Contact Subscribed

Starts the workflow when a new contact is added to a SendPulse mailing list.

StackAI registers a webhook with SendPulse for new mailing list subscriptions; no manual setup is needed in the SendPulse dashboard. 1. Optionally restrict to a single **Mailing List**. 2. Publish the trigger. SendPulse will start sending matching events to StackAI.

#### Configuration

| Field                  | Type            | Required | Description                                                                                   |
| ---------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------- |
| Only This Mailing List | select (string) | No       | Only react to contacts added to this mailing list. Options load from the selected connection. |

#### Event inputs

| Field           | Type   | Required | Description                                                                         |
| --------------- | ------ | -------- | ----------------------------------------------------------------------------------- |
| Email Address   | string | Yes      | The contact that was added.                                                         |
| Mailing List ID | string | No       | The mailing list the contact joined. Default: .                                     |
| Source          | string | No       | How the contact was added, for example a subscription form or an import. Default: . |
| Variables       | object | No       | Personalisation values captured with the subscription.                              |
| Occurred At     | string | No       | When SendPulse recorded the subscription.                                           |

#### Outputs

| Field           | Type     | Description                                                              |
| --------------- | -------- | ------------------------------------------------------------------------ |
| Email Address   | string   | The contact that was added.                                              |
| Mailing List ID | string   | The mailing list the contact joined.                                     |
| Source          | string   | How the contact was added, for example a subscription form or an import. |
| Variables       | dict     | Personalisation values captured with the subscription.                   |
| Occurred At     | datetime | When SendPulse recorded the subscription.                                |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/sendpulse.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
