> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fetchhive.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Omnisend

> Marketing automation for ecommerce businesses via your connected account.

Use this app when you need to sync ecommerce data with Omnisend. It works well for contacts, catalog items, carts, orders, and events.

## Configuration

| Option | Required | Description |
| - | - | - |
| Name | No | Label for the step in the workflow canvas. |
| Authentication | Yes | The connected Omnisend account to use for this step. |
| Action | Yes | The Omnisend action to perform (for example List Contacts, Get Contact, Create or Update Contact, List Products). |
| Arguments | Yes | Per-action form fields generated from the action's schema. Each text field has an **Insert Variable** button for injecting `{{placeholder}}` values. A **Raw JSON** tab is available for advanced usage. |
| When the step fails | No | Controls whether the workflow should **Terminate Workflow** or **Continue** if this step fails. |

Before you configure this step, connect Omnisend in **Integrations** for your workspace using the sign-in flow. If no active connection is available, the step shows a warning with a link to **Integrations** instead of the account selector.

## Arguments form

When you select an action, the **Arguments** section renders a form driven by the action's input schema. Fields that refer to existing records include dropdown pickers.

Switch to the **Raw JSON** tab when you prefer to write the full arguments object by hand. Changes in either tab stay in sync.

## Common actions

| Action | Description |
| - | - |
| **List Contacts** | Retrieve a paginated list of contacts with optional filtering. |
| **Get Contact** | Retrieve details of a single contact by ID. |
| **Create or Update Contact** | Create a contact or update an existing one using identifiers. |
| **List Products** | Retrieve a paginated list of products. |
| **Get Product** | Retrieve details of a specific product by ID. |
| **Create Product** | Create a new product in the catalog. |
| **List Product Categories** | Retrieve a paginated list of product categories. |
| **Get Product Category** | Retrieve details of a specific product category by ID. |
| **Create Product Category** | Create a new product category in the catalog. |
| **List Carts** | Retrieve a paginated list of carts with optional filtering. |
| **Get Cart** | Retrieve a specific cart by ID. |
| **Create Cart** | Create a new shopping cart. |
| **Create Order** | Create a new order with totals and currency. |
| **Get Order** | Retrieve details of a specific order by ID. |
| **Send Event** | Send a customer event to Omnisend. |

Destructive actions, such as deleting records, are not available in the workflow action picker.

## Output

This step stores the Omnisend response as the step output. The shape of the response depends on the action.

Use the full output reference in later steps:

```text theme={null}
{{STEP_IDENTIFIER.output}}
```

## Example

1. Open **Integrations** and connect Omnisend if you have not already done that.
2. Add an **Omnisend** step to your workflow.
3. Select a connected account in **Authentication**.
4. Choose **List Contacts** in **Action**.
5. Fill in the required fields. Use **Insert Variable** to reference an earlier step's output for any field value.
6. Click **Run** in the step header to test the action, then review the returned payload in **Output**.

## Use cases

### Sync a new customer

1. Create or Update Contact
2. Get Contact
3. Send Event

### Add a catalog item

1. Create Product
2. Get Product
3. List Products

### Track an order

1. Create Order
2. Get Order
3. Send Event

## Notes

* This step depends on a connected Omnisend integration in your workspace.
* The workflow action picker shows a curated set of actions. Agents with the Omnisend tool can use more of them.
* The sign-in screen may show third-party authorization branding.

## Using Omnisend as an Agent Tool

You can also add Omnisend as a tool in the **Agent Editor**. Open the agent, click **Add tool**, and select **Omnisend**. In the tool settings panel, choose the connected account the agent should use. The agent calls Omnisend actions when they are relevant to the conversation.

See also: [Integrations](https://docs.fetchhive.com/workspace/integrations.md), [Creating and Editing](https://docs.fetchhive.com/workflows/creating-and-editing.md), and [Testing and Iteration](https://docs.fetchhive.com/workflows/testing-and-iteration.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.