Workspaces

Authorization

Dittofeed

Welcome to the Dittofeed documentation and help center.

Introduction

Quick Start

Follow along to set up a Dittofeed workspace and start sending messages.

Video Walkthrough

dittofeed-ee

Glossary

Self-hosting Dittofeed

Using Dittofeed Cloud

Send Dittofeed data about your users and behaviors.

Data Sources

Message Channels

Conviently connect to Dittofeed from your favorite language environment.

SDK's

Send third party applications data from your Dittofeed workspace.

Data Destinations

Resources

Journeys

Segments

Templates

Manage groups of specific users, and their messaging preferences.

Subscription Groups

User Properties

Using broadcasts to manually trigger journeys.

Broadcasts

Groups

How to submit user events to Dittofeed's API.

Submitting User Events

Frequently Asked Questions (FAQ)

Creating Journeys

Accessing the Admin API

How to submit broadcasts to Dittofeed's API.

Submitting Broadcasts via API

How to add a mailing list or newsletter to your website.

Mailing List / Newsletter

Git Based Workflows

Running Dittofeed Locally

System Architecture

Updating Dittofeed's API Docs

The Identify call lets you tie a user to their actions and record traits about them. It includes a unique User ID and any optional traits you know about the user, like their email, name, and more.

POST /api/public/apps/identify

The Track call is how you record any actions your users perform, along with any properties that describe the action.

POST /api/public/apps/track

The page call lets you record whenever a user sees a page of your website, along with any optional properties about the page.

POST /api/public/apps/page

The screen call lets you record whenever a user sees a screen, the mobile equivalent of page, in your mobile app, along with any properties about the screen

POST /api/public/apps/screen

The group call lets you assign or unassign a user to a group, along with optionally adding traits to the group.

POST /api/public/apps/group

The batch method lets you send a series of identify, group, track, page and screen requests in a single batch, saving on outbound requests.

POST /api/public/apps/batch

Used to consume segment.io webhook payloads. Must be exposed publicly to the internet.

POST /api/public/webhooks/segment

GET /api/admin/content/templates

PUT /api/admin/content/templates

DELETE /api/admin/content/templates

GET /api/admin/segments/

PUT /api/admin/segments/

DELETE /api/admin/segments/

GET /api/admin/user-properties/

PUT /api/admin/user-properties/

DELETE /api/admin/user-properties/

GET /api/admin/journeys/

PUT /api/admin/journeys/

DELETE /api/admin/journeys/

Allows users to manage their subscriptions.

PUT /api/public/subscription-management/user-subscriptions

Get /api/admin/users/subscriptions

POST /api/admin/users/

Delete events, and computed properties and segments for specific users.

DELETE /api/admin/users/

GET /api/admin/events/

POST /api/admin/broadcasts/execute

PUT /api-l/admin/workspaces/child

DELETE /api-l/admin/workspaces

GET /api-l/admin/workspaces/

POST /api-l/sessions/

GET /api/admin/groups/user-groups

GET /api/admin/groups/users

GET /api/admin/deliveries/

PUT /api/settings/email-providers

PUT /api/settings/sms-providers

POST /api/admin/segments/manual-segment/update

POST /api/admin/segments/manual-segment/clear

GET /api/admin/segments/manual-segment/status

Learn how to embed Dittofeed in your application.

Getting Started

Embedded Components Introduction

Self-Host with Render

Self-Host with Docker Compose

Self-Host with Kubernetes

Self-Host with AWS Cloudformation

Authentication and Authorization in Dittofeed

How Dittofeed writes data from its API layer to ClickHouse.

Write Modes

Using Segment.io as a Source

Send data directly to Dittofeed's segment compatible API.

Using Dittofeed's REST API as a source

Pull data from databases and data warehouses into Dittofeed using reverse ETL.

Using Dittofeed's Polytomic Integration

Sending Email with Dittofeed

SendGrid Integration

Postmark Integration

Resend Integration

SMTP Server Integration

Amazon SES Integration

Sending SMS with Dittofeed

Twilio SMS Integration

Triggering Webhooks with Dittofeed

Mailchimp Integration via Mandrill

Send events from your web app to Dittofeed's API

Web SDK

Send events from your node app to Dittofeed's API

Node.js SDK

Send events from your React Native app to Dittofeed's API

React Native SDK

Hubspot Destination

CSV Export Destination

Define who is allowed to enter a Journey, and when they enter it.

Entry - Journey Node

Message - Journey Node

Wait for a user to enter a segment, with some timeout.

Wait For - Journey Node

Wait for some fixed amount of time to progress.

Delay - Journey Node

Condition messages depending on whether they're in a segment.

Segment Split - Journey Node

Used to mark a user's exit from a journey.

Exit - Journey Node

Restrict a segment to users with a specific trait value.

Trait - Segment Node

Condition on whether users have performed a specific action.

Performed - Segment Node

Allow any users to join the segment if they satisfy one condition "And" another condition.

And - Segment Node

Allow any users to join the segment if they satisfy one condition "Or" another condition.

Or - Segment Node

Specify a segment by manually uploading a CSV of users.

Manual - Segment Node

Restrict a segment to members of a subscription group.

Subscription Group - Segment Node

Segment on the outcome of a particular email.

Email - Segment Node

Randomly assign a percentage of users to a segment.

Random Bucket - Segment Node

Condition on whether users have performed a specific action - Immediately.

Keyed Performed Segment

Email Template Editor

MJML Responsive Email

Liquid Presets

Free MJML Email Templates

SMS Template Editor

Webhook Template Editor

Trait - User Property

Performed - User Property

Any Of - User Property

File - User Property

User Id - User Property

Anonymous Id - User Property

Renders the value of a specific event property - immediately.

Keyed Performed - User Property

Example journey for sending appointment reminders to users.

Appointment Reminders

GET /api/admin/subscription-groups

Create or update user subscription group assignments. This performs a patch update on the user's subscription group assignments.

Getting Started

Deployment

Integrations

Workspace Resources

User Guides

Contributing

Workspaces