OMomnisend
Event Metadata

Create custom event metadata

Declares a new brand-custom event schema. The event identity is the combination of name and origin; displayName and at least one top-level property are required. Optional metadata fields must be omitted rather than sent as null. The created event is returned with every node flagged explicitlyDefined.

Scopes: events.write

Rate Limiting: This endpoint is rate limited to 400 requests per minute.

post/event-metadata

Request

  • Base URL
    https://api.omnisend.com/api
  • URL
    https://api.omnisend.com/api/event-metadata
  • Auth
    • API key in header Authorization
    • or OAuth 2
      Client credentials
      Token URL: https://app.omnisend.com/oauth2/token

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Request body

displayNamestring

Human-readable label. Required on POST; omit on PUT to keep the stored value.

namestring required

Machine-readable event name

originstring required

Single origin the schema belongs to

propertiesobject

Property tree keyed by property name. Required with at least one key on POST; on PUT only the keys present are merged.

Example request

{
  "displayName": "Loyalty Points Earned",
  "name": "loyalty points earned",
  "origin": "api"
}

Response

The created event metadata

Example response

{
  "event": {
    "displayName": "Placed Order",
    "name": "placed order",
    "origins": [
      "shopify",
      "woocommerce"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.