Shout a Signal into the Walkie-Talkie

curl -X POST 'https://api.mailofly.com/events/send' \
  -H 'Authorization: Bearer mf_live_xxxxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
    "event": "user.signup",
    "email": "maya@example.com",
    "payload": {
      "first_name": "Maya",
      "plan": "pro"
    }
  }'

import { Mailofly } from "@mailofly/node";

const mailofly = new Mailofly("mf_live_xxxxxxxx");

const fired = await mailofly.events.send({
  event: "user.signup",
  email: "maya@example.com",
  payload: {
    first_name: "Maya",
    plan: "pro"
  }
});

console.log("Walkie-talkie signal heard:", fired.event);

{
  "object": "event",
  "event": "user.signup"
}

POST

events

send

curl -X POST 'https://api.mailofly.com/events/send' \
  -H 'Authorization: Bearer mf_live_xxxxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
    "event": "user.signup",
    "email": "maya@example.com",
    "payload": {
      "first_name": "Maya",
      "plan": "pro"
    }
  }'

import { Mailofly } from "@mailofly/node";

const mailofly = new Mailofly("mf_live_xxxxxxxx");

const fired = await mailofly.events.send({
  event: "user.signup",
  email: "maya@example.com",
  payload: {
    first_name: "Maya",
    plan: "pro"
  }
});

console.log("Walkie-talkie signal heard:", fired.event);

{
  "object": "event",
  "event": "user.signup"
}

Whenever a user does something special in your app, shout into the walkie-talkie! Calling this endpoint rings the doorbell on any active automations listening for this event, kicking off a brand-new journey for that user right away.

Body

string

required

The name of the signal that just fired (e.g. "user.signup" or "invoice.paid").

string

The email address of the person who did the action. (You must provide either email or contact_id).

string

The ID of the contact if they already live in your Mailofly Audience.

object

The backpack of goodies! Put any custom variables here that your email templates or conditions want to use:

{
  "first_name": "Maya",
  "order_id": "ORD-9912",
  "amount": 49
}

Response

string

Always says "event".

string

Echoes back the name of the signal that Mailofly heard and accepted.

curl -X POST 'https://api.mailofly.com/events/send' \
  -H 'Authorization: Bearer mf_live_xxxxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
    "event": "user.signup",
    "email": "maya@example.com",
    "payload": {
      "first_name": "Maya",
      "plan": "pro"
    }
  }'

import { Mailofly } from "@mailofly/node";

const mailofly = new Mailofly("mf_live_xxxxxxxx");

const fired = await mailofly.events.send({
  event: "user.signup",
  email: "maya@example.com",
  payload: {
    first_name: "Maya",
    plan: "pro"
  }
});

console.log("Walkie-talkie signal heard:", fired.event);

{
  "object": "event",
  "event": "user.signup"
}

API Reference

Sending

Receiving

Campaigns

Templates

Automations

Events

Contacts

Contact Properties

Contact Imports

Segments

Topics

Domains

Identities

Logs

Usage

API Keys

Suppressions

Webhooks

Shout a Signal into the Walkie-Talkie

Body

Response

​Body

​Response

Body

Response