Create Event

Options

Body

Request body which must comply to the following JSON Schema:

{
  "required" : [ "event_name", "identifiers" ],
  "type" : "object",
  "properties" : {
    "event_name" : {
      "type" : "string",
      "description" : "The name of the event that occurred. This is how you will find your event in Brevo. Limited to 255 characters, alphanumerical characters and - _ only.",
      "example" : "video_played"
    },
    "event_date" : {
      "type" : "string",
      "description" : "Timestamp of when the event occurred (e.g. \"2024-01-24T17:39:57+01:00\"). If no value is passed, the timestamp of the event creation is used.",
      "example" : "2024-02-06T20:59:23.383Z"
    },
    "identifiers" : {
      "minProperties" : 1,
      "type" : "object",
      "properties" : {
        "email_id" : {
          "type" : "string",
          "description" : "Email Id associated with the event",
          "example" : "jane.doe@example.com"
        },
        "phone_id" : {
          "type" : "string",
          "description" : "SMS associated with the event",
          "example" : "+91xxxxxxxxxx"
        },
        "whatsapp_id" : {
          "type" : "string",
          "description" : "whatsapp associated with the event",
          "example" : "+91xxxxxxxxxx"
        },
        "landline_number_id" : {
          "type" : "string",
          "description" : "landline_number associated with the event",
          "example" : "+91xxxxxxxxxx"
        },
        "ext_id" : {
          "type" : "string",
          "description" : "ext_id associated with the event",
          "example" : "abc123"
        }
      },
      "description" : "Identifies the contact associated with the event. At least one identifier is required."
    },
    "contact_properties" : {
      "type" : "object",
      "additionalProperties" : {
        "anyOf" : [ {
          "type" : "string"
        }, {
          "type" : "integer"
        } ]
      },
      "description" : "Properties defining the state of the contact associated to this event. Useful to update contact attributes defined in your contacts database while passing the event. For example: **\"FIRSTNAME\": \"Jane\" , \"AGE\": 37**",
      "example" : {
        "AGE" : 32,
        "GENDER" : "FEMALE"
      }
    },
    "event_properties" : {
      "type" : "object",
      "additionalProperties" : {
        "anyOf" : [ {
          "type" : "string"
        }, {
          "type" : "integer"
        }, {
          "type" : "object"
        }, {
          "type" : "array"
        } ]
      },
      "description" : "Properties of the event. Top level properties and nested properties can be used to better segment contacts and personalise workflow conditions. The following field type are supported: string, number, boolean (true/false), date (Timestamp e.g. \"2024-01-24T17:39:57+01:00\"). Keys are limited to 255 characters, alphanumerical characters and - _ only. Size is limited to 50Kb.",
      "example" : {
        "video_title" : "Brevo — The most approachable CRM suite",
        "vide_description" : "Create your free account today!",
        "duration" : 142,
        "autoplayed" : false,
        "upload_date" : "2023-11-24T12:09:10+01:00"
      }
    }
  }
}

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Raw Response: Returns the raw response in a single row with the following columns:

• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers