Prerequisites

1. Install

2. Getting Started

3. Try it yourself

Learn how to configure and send your first email with Ruby

Use SendX with Ruby

SendX Docs

Introduction

Understand the basics of SendX REST convention and common parameters

Detailed overview of all objects used within SendX REST API

Schemas

Identify a contact by email address. If the contact already exists, it will be updated.

Identify contact

Add Tracking info

Get All Contacts

Create a contact

Retrieve a specific contact by its identifier.

Get Contact by Identifier

Update Contact

Delete Contact

Unsubscribe Contact

Get All Campaigns

Create Campaign

Retrieve a specific campaign using its ID.

Get Campaign By Id

Submit edited content for a specific campaign.

Edit Campaign

Deletes a specific campaign by its campaignId.

Delete Campaign

Get All Lists

Create List

Get List

Update List

Delete List

Retrieve all tags for the account with optional pagination and search filters

Get All Tags

Create a Tag

Retrieve a tag based on the provided tag ID

Get a Tag by ID

Update a Tag

Delete a Tag

Retrieve the campaign report data based on the provided campaign id.

Get CampaignReport Data

Retrieve all senders for the team, with optional filters like offset, limit, and search.

Get All Senders

Create Sender


This API allows you to push a custom event for a specified contact, including any additional properties you wish to associate with the event.


## Request Properties





 Property   | Type                | Description                                                                                                                                          
------------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------
 name       | `string`            | The name of the custom event.                                                                                                                        
 identifier | `string`            | A unique identifier for the contact (e.g., an email address).                                                                                        
 data       | `map[string]string` | A set of key-value pairs containing additional event properties.                                                                                     
 time       | `int64` (optional)  | Unix timestamp (in seconds since January 1, 1970) representing when the event occurred. If omitted, the current request time will be used.          


### Example Request:
```json
{
  "name": "abandoned_cart",
  "identifier": "john.doe@example.com",
  "data": {
    "price": "29.99",
    "currency": "USD",
    "item_count": "3"
  },
  "time": 1669990400
}
``` 


Push a custom event associated with a contact

Records a revenue event, which can be attributed to campaigns, drips, workflows, or other sources of user interaction.

Record a revenue event for a specific contact

Trigger a revenue postback for a specific team and event.

Revenue event postback url

Register a custom event for a specific team and event.

Custom event postback url

Retrieve all team webhooks for the requesting team.

Get All team Webhook

Create TeamWebhook

Retrieve a specific team webhook by its ID.

Get TeamWebhook

Update an existing team webhook with new content.

Update Team Webhook

Delete a specific team webhook by its ID.

Delete Team Webhook

SendX Webhook Object

Get All Custom Fields

Create a custom field with the given data.

Documentation

Quickstart

Use SendX with Ruby

Prerequisites

1. Install

2. Getting Started

3. Try it yourself

Ruby Example

Documentation

Quickstart

​Prerequisites

​1. Install

​2. Getting Started

​3. Try it yourself

Ruby Example

Prerequisites

1. Install

2. Getting Started

3. Try it yourself