Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Structure

  • access_key: (Required; Hex-encoded bytes) The  The access component of the API key with which the client_salt and client_secret are associated.
  • client_salt: (Required; Hex-encoded bytes) The client_salt which is paired with the access_key and was used in order to derive the client_secret, which is used in turn to sign the payload, generating the Payload_HMAC header for the event request.
  • timestamp: (Required; ISO-8601 formatted with at least second-level granularity) The current timestamp.
    • This is compared with the server's current time this must be within 1 minute of server time when it is processed. This is a security measure to prevent replay attacks using an old event payload.
  • debug_directive: (Optional; Text) A directive that can be used for simple testing. Currently only one value is permitted if present.
    • echo-as-message: skips all rule evaluation and sends a message with the event as the payload.
  • event_name: (Required; Text) The name of the event which will be included in messages generated by a campaign when this was the event which caused that campaign's rules to be evaluated.
  • namespace: (Required; Text) The namespace with which this event is associated, which determines the attribute schema.
  • attributes: (Required; JSON object) Object containing namespace specific attributes. All primary key attributes must be present, or the request will be rejected.
    • The names and types of the supplied attributes must match those defined either within the namespace above, or defined as core attributes on the customer's account.
  • tags: (Optional; JSON array containing text values) Additional metadata that can be passed along in the event.

...