The Reminder object

A Reminder represents a scheduled notification that must be fired at a specific time in the future. Once a reminder’s due time is reached, a webhook event (reminder.due) is automatically sent to your system with details about the reminder.

The following fields are included in every reminder object on the Voxity platform and define the structure of a reminder.

{
  "id": "reminder_123456",
  "purpose": "Follow up with lead",
  "context": "sales",
  "timestamp": 1711801800000,
  "status": "scheduled",
  "metadata": {
    "channel": "email",
    "priority": "high"
  },
  "taskId": "task_987654",
  "customerId": "cust_456789",
  "opportunityId": "opp_123789",
  "createdAt": "2025-03-25T12:00:00Z",
  "updatedAt": "2025-03-25T12:05:00Z"
}

Attributes

• id (string): A unique identifier for the reminder. Example: "reminder_123456"

• purpose (string): A short description of why the reminder exists or what action is expected. Example: "Follow up with lead"

• context (string): The business context or domain where this reminder applies (e.g., sales, onboarding, support). Example: "sales"

• timestamp (number): The UNIX timestamp (in milliseconds) representing when the reminder is due. Example: 1711801800000

• status (string): The current status of the reminder. Valid values are:

  • "pending" – The reminder has been created but not yet scheduled.

  • "scheduled" – The reminder is scheduled to trigger at the specified time.

  • "due" – The reminder has reached its due time and is being processed.

  • "completed" – The reminder was successfully triggered.

  • "cancelled" – The reminder was cancelled before it could be triggered. Example: "scheduled"

• metadata (object): A flexible object for storing additional data relevant to the reminder, such as source, priority, or channel. Example: { "channel": "email", "priority": "high" }

• taskId (string): The ID of the task associated with this reminder. Example: "task_987654"

• customerId (string, nullable): The ID of the customer linked to the reminder, if any. Example: "cust_456789"

• opportunityId (string, nullable): The ID of the opportunity linked to the reminder, if applicable. Example: "opp_123789"

• createdAt (string): The ISO 8601 timestamp when the reminder was created. Example: "2025-03-25T12:00:00Z"

• updatedAt (string): The ISO 8601 timestamp when the reminder was last updated. Example: "2025-03-25T12:05:00Z"