(API) Lifecycle of a Container (states description)

A Container has an attribute called state which defines the current state of your Container.

This attribute value has four possible values, they are: created, send, sent, completed

The Container respects the following lifecycle:

created => send => sent => [send or complete]

*The sent state may transition back to send if you want to resend that Container to the Recipient.

States

  1. created
    The Container was only created, it is not accessible by everyone. Only you can add/edit/delete functionalities to this Container through API calls.

  2. send
    A Container is marked as send when you request that Container to be sent through the API call to send the notification. The container will be queued for sending and, it will transition to another state as soon it is sent.

  3. sent
    As soon the Container is sent successfully, the Container transition to a sent state. This state indicates the Container is available for your included Recipient(s) set at the time of creation and, it will be until you terminate the Container or the expiration times runs by.

  4. completed
    This is the final state of a Container. When the expiration of a Container runs by or you terminate that Container, we mark that Container as completed. This means the Container is not accessible by anyone. You can only perform Container actions through API calls according to the Feature(s) that Container has. For instance, a Container may have a Pull Feature inside, at this point you would download any file associated with that Pull. When a Container get’s to this state, it marks all Feature(s) it has as complete.