EventSubscriptionResponse

object

Properties associated with an event subscription.

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

entity_typestringrequired

Allowed values:billing-invoiceaccess-tokenwebhookdev-portaldataplane-groupdataplanekai-enablemententerprise-trial

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

regionsarray[string]required

Region associated to a notification.

Allowed values:USEUAUMEIN*

entitiesarray[string]required

ID of the entity. Use ‘*’ to represent all entities of this type.

channelsarray[object]required

Channel subscription details for an event.

Show Child Parameters
enabledbooleanrequired

Enable/Disable complete subscription within an event.

namestringrequired

User provided name of the subscription.

Example

EventSubscription

object

Properties associated with an event subscription.

regionsarray[string]required

Region associated to a notification.

Allowed values:USEUAUMEIN*

entitiesarray[string]required

ID of the entity. Use ‘*’ to represent all entities of this type.

channelsarray[object]required

Channel subscription details for an event.

Show Child Parameters
enabledbooleanrequired

Enable/Disable complete subscription within an event.

namestringrequired

User provided name of the subscription.

Example

BulkPayload

object

Request body schema for bulk status update.

idsarray[string]requiredunique-items

>= 1 items<= 100 items

statusstringrequired

Status of the notification.

Allowed values:READUNREADARCHIVED

Example

LegacyStringFieldFilter

object

Filter using one of the following operators: eq, contains

* Additional properties are NOT allowed.
eqstring

The field exactly matches the provided value.

Example:?filter[field_name_here][eq]=foo

containsstring

The field contains the provided value.

Example:?filter[field_name_here][contains]=foo

Example

UUID

string

Contains a unique identifier used for this resource.

Example