Package com.vonage.client.proactiveconnect

Class Event

java.lang.Object
com.vonage.client.JsonableBaseObject
com.vonage.client.proactiveconnect.Event
All Implemented Interfaces:
Jsonable
public class Event extends JsonableBaseObject
Represents an event in the Proactive Connect API.

  • Constructor Details

    • Event

      protected Event()

  • Method Details

    • getData

      public Map<String,?> getData()
      Custom data as key-value pairs for this event.
      Returns:
      The event data as a Map, or null if absent.

    • getId

      public UUID getId()
      Unique identifier for this item.
      Returns:
      The item ID or null if unknown.

    • getJobId

      public UUID getJobId()
      Unique identifier for the job.
      Returns:
      The job ID or null if unknown.

    • getRunId

      public UUID getRunId()
      Unique identifier for the run.
      Returns:
      The run ID or null if unknown.

    • getRunItemId

      public UUID getRunItemId()
      Identifier for the item ID during a job run - this is the list item ID which is copied while taking the list snapshot.
      Returns:
      The run's item ID or null if unknown.

    • getActionId

      public UUID getActionId()
      Unique identifier for the action.
      Returns:
      The action ID or null if unknown.

    • getInvocationId

      public UUID getInvocationId()
      Unique identifier for the action invocation.
      Returns:
      The action invocation ID or null if unknown.

    • getRecipientId

      public String getRecipientId()
      String identifier of a recipient, for example their email, phone number etc.
      Returns:
      The recipient ID or null if unknown.

    • getSourceContext

      public String getSourceContext()
      The name of the segment or matcher.
      Returns:
      The source context or null if unknown.

    • getOccurredAt

      public Instant getOccurredAt()
      Date and time the event occurred in ISO 8601 format.
      Returns:
      The event timestamp or null if unknown.

    • getType

      public EventType getType()
      Classification of the event.
      Returns:
      The event type as an enum.

    • fromJson

      public static Event fromJson(String json)
      Creates an instance of this class from a JSON payload.
      Parameters:
      json - The JSON string to parse.
      Returns:
      An instance of this class with the fields populated, if present.