Skip to content

Latest commit

 

History

History
29 lines (24 loc) · 8.86 KB

triggereventtoallrequestdto.md

File metadata and controls

29 lines (24 loc) · 8.86 KB

TriggerEventToAllRequestDto

Example Usage

import { TriggerEventToAllRequestDto } from "@novu/api/models/components";

let value: TriggerEventToAllRequestDto = {
  name: "<value>",
  payload: {
    "comment_id": "string",
    "post": {
      "text": "string",
    },
  },
  overrides: {},
};

Fields

Field Type Required Description Example
name string ✔️ The trigger identifier associated for the template you wish to send. This identifier can be found on the template page.
payload Record<string, any> ✔️ The payload object is used to pass additional information that
could be used to render the template, or perform routing rules based on it.
For In-App channel, payload data are also available in 		{
"comment_id": "string",
"post": {
"text": "string"
}
}
overrides components.Overrides ➖ This could be used to override provider specific configurations {
"fcm": {
"data": {
"key": "value"
}
}
}
transactionId string ➖ A unique identifier for this transaction, we will generated a UUID if not provided.
actor components.TriggerEventToAllRequestDtoActor ➖ It is used to display the Avatar of the provided actor's subscriber id or actor object.
If a new actor object is provided, we will create a new subscriber in our system
tenant components.TriggerEventToAllRequestDtoTenant ➖ It is used to specify a tenant context during trigger event.
If a new tenant object is provided, we will create a new tenant.