Invent a New Signal

curl -X POST 'https://api.mailofly.com/events' \
  -H 'Authorization: Bearer mf_live_xxxxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "user.signup",
    "schema": {
      "first_name": "string",
      "plan": "string"
    }
  }'

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

const mailofly = new Mailofly("mf_live_xxxxxxxx");

const eventDef = await mailofly.events.create({
  name: "user.signup",
  schema: {
    first_name: "string",
    plan: "string"
  }
});

console.log("Invented signal ID:", eventDef.id);

{
  "object": "event",
  "id": "evt_4b219081-3a11-4821-b810-091827361821"
}

POST

events

curl -X POST 'https://api.mailofly.com/events' \
  -H 'Authorization: Bearer mf_live_xxxxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "user.signup",
    "schema": {
      "first_name": "string",
      "plan": "string"
    }
  }'

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

const mailofly = new Mailofly("mf_live_xxxxxxxx");

const eventDef = await mailofly.events.create({
  name: "user.signup",
  schema: {
    first_name: "string",
    plan: "string"
  }
});

console.log("Invented signal ID:", eventDef.id);

{
  "object": "event",
  "id": "evt_4b219081-3a11-4821-b810-091827361821"
}

Before your app starts shouting signals to Mailofly, you can register a new event definition! This teaches Mailofly what name the signal will use (like user.signed_up) and what properties to expect in its backpack (like first_name or plan).

Body

string

required

The unique name for this signal! Usually written with dot notation, like "user.signup" or "item.purchased".

object

A map of expected backpack items and their types (string, number, or boolean). For example:

{
  "first_name": "string",
  "amount": "number",
  "is_trial": "boolean"
}

Response

string

Always says "event".

string

The unique ID badge assigned to this new signal definition.

curl -X POST 'https://api.mailofly.com/events' \
  -H 'Authorization: Bearer mf_live_xxxxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "user.signup",
    "schema": {
      "first_name": "string",
      "plan": "string"
    }
  }'

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

const mailofly = new Mailofly("mf_live_xxxxxxxx");

const eventDef = await mailofly.events.create({
  name: "user.signup",
  schema: {
    first_name: "string",
    plan: "string"
  }
});

console.log("Invented signal ID:", eventDef.id);

{
  "object": "event",
  "id": "evt_4b219081-3a11-4821-b810-091827361821"
}

API Reference

Sending

Receiving

Campaigns

Templates

Automations

Events

Contacts

Contact Properties

Contact Imports

Segments

Topics

Domains

Identities

Logs

Usage

API Keys

Suppressions

Webhooks

Invent a New Signal

Body

Response

​Body

​Response

Body

Response