A Subscription is defined and managed under an organization and is identified in the system by its unique ID, the UUID.
The following table describes the fields in the REST API messages for subscriptions:
Field | Type | Description |
---|---|---|
id | string | The UUID. A unique ID of the subscription. |
created_at | date | The creation time of the subscription. Standard format of timestamp with a time zone. ISO_8601 |
updated_at | date | The time when the subscription details were last updated. Standard format of timestamp with a time zone. ISO_8601 |
type | string | The type of subscription. One of the following: * ELECTIONS * DEPOSITS * TRANSACTIONS |
notification_channels | object | Notification channels for this subscription. |
organization_id | string | The organization id this settlement belongs to. See Organization Object |
Notification Channel Object
Field | Type | Description |
---|---|---|
id | string | The UUID. A unique ID of the notification channel. |
created_at | date | The creation time of the notification channel. Standard format of timestamp with a time zone. ISO_8601 |
updated_at | date | The time when the notification channel details were last updated. Standard format of timestamp with a time zone. ISO_8601 |
channel_type | string | The type of subscription. One of the following: * WEBHOOK * SLACK * TELEGRAM |
address | string | Email address or Webhook URL for this notification object. |