OBJECT

TriggeredEmail

An Email that is sent when a particular event occurs.

link GraphQL Schema definition

  • type TriggeredEmail implements NoteableInterface, LoggableInterface, AccessloggableInterface {
  • # The ID of the entity.
  • id: Int64Bit!
  • # An ID that uniquely identifies this entity across the whole Sonar system.
  • sonar_unique_id: ID!
  • # The date and time this entity was created.
  • created_at: Datetime!
  • # The last date and time this entity was modified.
  • updated_at: Datetime!
  • # A string that shows the version of this entity. It will be incremented whenever
  • # the entity is modified.
  • _version: String!
  • # Whether or not child accounts are allowed.
  • allow_children: Boolean!
  • # The count associated with this `TriggeredEmail`. This is defined by the trigger,
  • # and could be something like a number of days, months, gigabytes, etc.
  • count: Int
  • # The ID of an EmailMessage.
  • email_message_id: Int64Bit!
  • # Whether or not this is enabled.
  • enabled: Boolean!
  • # The ID of a `JobType`.
  • job_type_id: Int64Bit
  • # A descriptive name.
  • name: String!
  • # If an item is protected, it cannot be modified or deleted.
  • protected: Boolean!
  • # The trigger for this message.
  • trigger: EmailTrigger!
  • # An email message.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # from_email_address: The email address to send from when using
  • # this email message. If `null`, then the system default will be used.
  • # from_name: The name to send from when using this email message.
  • # If `null`, then the system default will be used.
  • # name: A descriptive name.
  • # saved_message_category_id: ID of the Saved Message Category.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • email_message(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • from_email_address: EmailAddress,
  • from_name: String,
  • name: String,
  • saved_message_category_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): EmailMessage
  • # The type of a `Job`.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # account_status_id_completion: If this is set, any `Job` using
  • # this `JobType` that is completed successfully while associated with an `Account`
  • # will change the `Account` to this `AccountStatus`.
  • # account_status_id_failure: If this is set, any `Job` using this
  • # `JobType` that is completed unsuccessfully while associated with an `Account`
  • # will change the `Account` to this `AccountStatus`.
  • # action_on_completion: Completion ticket action.
  • # action_on_failure: Failure ticket action.
  • # all_companies: Whether or not this `JobType` is valid for all
  • # `Companies`.
  • # allow_completion_with_incomplete_tasks: Whether `Job`s
  • # associated with this `JobType` should be able to be completed with incomplete
  • # tasks.
  • # color: Color.
  • # contract_template_id: The ID of a `ContractTemplate`.
  • # default_length_in_minutes: The default length for a `Job`
  • # created using this `JobType`.
  • # disconnects_account: If this is set, any `Job` using this
  • # `JobType` that is completed successfully while associated with an `Account` will
  • # trigger the disconnection of the `Account`.
  • # enabled: Whether or not this is enabled.
  • # icon: An icon.
  • # name: A descriptive name.
  • # task_template_id: The ID of a `TaskTemplate`.
  • # ticket_group_id_completion: If this is set, any `Job` using
  • # this `JobType` that is completed successfully will create a `Ticket` and assign
  • # it to this `TicketGroup`.
  • # ticket_group_id_failure: If this is set, any `Job` using this
  • # `JobType` that is completed unsuccessfully will create a `Ticket` and assign it
  • # to this `TicketGroup`.
  • # ticket_status_on_completion: Ticket status on completion.
  • # ticket_status_on_failure: Ticket status on failure.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • job_type(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_status_id_completion: Int64Bit,
  • account_status_id_failure: Int64Bit,
  • action_on_completion: JobTypeAction,
  • action_on_failure: JobTypeAction,
  • all_companies: Boolean,
  • allow_completion_with_incomplete_tasks: Boolean,
  • color: HtmlHexColor,
  • contract_template_id: Int64Bit,
  • default_length_in_minutes: Int,
  • disconnects_account: Boolean,
  • enabled: Boolean,
  • icon: Icon,
  • name: String,
  • task_template_id: Int64Bit,
  • ticket_group_id_completion: Int64Bit,
  • ticket_group_id_failure: Int64Bit,
  • ticket_status_on_completion: TicketStatus,
  • ticket_status_on_failure: TicketStatus,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): JobType
  • # A categorization of a message by type.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # default: Whether or not this entity is a default entry.
  • # name: A descriptive name.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • message_categories(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • default: Boolean,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): MessageCategoryConnection!
  • # A categorization of an `Email` by type.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # default: Whether or not this entity is a default entry.
  • # name: A descriptive name.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • email_categories(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • default: Boolean,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): EmailCategoryConnection!
  • # An invoice.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # account_id: The ID of an Account.
  • # auto_pay_attempts: The number of times that auto pay has been
  • # attempted.
  • # auto_pay_date: The date that auto pay will be attempted.
  • # child_invoice_remaining_due: The sum of all due amounts on
  • # child invoices.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # date: A date
  • # delinquency_date: The date that this became delinquent.
  • # delinquent: Whether or not this entity is delinquent.
  • # due_date: The date this invoice is due by.
  • # end_date: The date that this ends.
  • # frozen: If an invoice is frozen, payments will not be
  • # automatically applied to it, and it cannot be modified.
  • # late_fee_applied: Whether or not a late fee has been applied.
  • # late_fee_only: Whether or not the invoice includes only late
  • # fees.
  • # message: The message.
  • # number_of_months: The number of months of service this invoice
  • # was billed for.
  • # parent_invoice_id: The ID of the `Invoice` that is this
  • # `Invoice`s master.
  • # pending_email: Used by system to indicate the invoice has been
  • # marked to be sent to email contacts.
  • # remaining_due: The amount remaining to be paid.
  • # status: The phase of the invoice moving through creation.
  • # tax_committed: Whether this entity's taxes have been committed
  • # or not.
  • # tax_provider_id: The ID of an `TaxProvider`.
  • # total_debits: The sum of all debits that make up this invoice.
  • # total_taxes: The sum of all taxes on debits that make up this
  • # invoice.
  • # void: Whether or not this entity has been voided.
  • # voided_at: When this was voided.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • invoices(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • auto_pay_attempts: Int,
  • auto_pay_date: Date,
  • child_invoice_remaining_due: Int,
  • company_id: Int64Bit,
  • date: Date,
  • delinquency_date: Date,
  • delinquent: Boolean,
  • due_date: Date,
  • end_date: Date,
  • frozen: Boolean,
  • late_fee_applied: Boolean,
  • late_fee_only: Boolean,
  • message: Text,
  • number_of_months: Int,
  • parent_invoice_id: Int64Bit,
  • pending_email: Boolean,
  • remaining_due: Int,
  • status: String,
  • tax_committed: Boolean,
  • tax_provider_id: Int64Bit,
  • total_debits: Int,
  • total_taxes: Int,
  • void: Boolean,
  • voided_at: Datetime,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): InvoiceConnection!
  • # Accounts exceeding a data usage triggered email.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # account_status_id: The ID of an AccountStatus.
  • # account_type_id: The ID of an AccountType.
  • # activation_date: The date an account was first activated.
  • # activation_time: The time an account was first activated.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # data_usage_percentage: The percentage of the data usage cap
  • # that this account has consumed this month, taking into account any data usage
  • # top offs.
  • # geopoint: A geo-point.
  • # is_delinquent: Whether or not this account is delinquent.
  • # name: A descriptive name.
  • # next_bill_date: The next date this service will bill. If this
  • # is null, it will bill on the next account billing date.
  • # next_recurring_charge_amount: The next recurring charge amount
  • # for an account. This is the sum of data, expiring, recurring, and voice services
  • # of an account for this billing cycle, including tax.
  • # parent_account_id: The ID of the `Account` that is this
  • # `Account`s master.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • accounts_exceeding_usage_triggers(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_status_id: Int64Bit,
  • account_type_id: Int64Bit,
  • activation_date: Date,
  • activation_time: Time,
  • company_id: Int64Bit,
  • data_usage_percentage: Int,
  • geopoint: Geopoint,
  • is_delinquent: Boolean,
  • name: String,
  • next_bill_date: Date,
  • next_recurring_charge_amount: Int,
  • parent_account_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountConnection!
  • # A note.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # message: The message.
  • # noteable_id: The ID of the entity that owns this note.
  • # noteable_type: The type of entity that owns this note.
  • # priority: The priority of this item.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • notes(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • message: Text,
  • noteable_id: Int64Bit,
  • noteable_type: NoteableType,
  • priority: NotePriority,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): NoteConnection!
  • # A log entry.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # current: Current data.
  • # legacy: Whether or not this log was transferred from a Sonar v1
  • # instance. If so, the formatting will not match current version logs.
  • # legacy_title: A title which is only populated on logs that were
  • # imported from Sonar v1.
  • # level: The severity level.
  • # loggable_id: The ID of the entity that this log is attached to.
  • # loggable_type: The type of entity that this log is attached to.
  • # logged_entity_id: The entity ID that triggered the log.
  • # logged_entity_type: The entity that triggered the log.
  • # message: The message.
  • # previous: Previous data.
  • # relation_data: Data from objects related to this change.
  • # type: The type.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • logs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • current: Text,
  • legacy: Boolean,
  • legacy_title: String,
  • level: LogLevel,
  • loggable_id: Int64Bit,
  • loggable_type: String,
  • logged_entity_id: Int64Bit,
  • logged_entity_type: String,
  • message: Text,
  • previous: Text,
  • relation_data: Text,
  • type: LogType,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): LogConnection!
  • # An access log history on an entity.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # access_datetime: The date and time that this entity was
  • # accessed.
  • # accessloggable_id: The ID of the entity that this access log
  • # belongs to.
  • # accessloggable_type: The entity that this access log belongs
  • # to.
  • # entity_id: The ID of the entity that this access log belongs
  • # to.
  • # entity_name: The entity that this access log belongs to.
  • # user_id: The ID of the user that accessed this entity.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • access_logs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • access_datetime: Datetime,
  • accessloggable_id: Int64Bit,
  • accessloggable_type: String,
  • entity_id: Int64Bit,
  • entity_name: String,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccessLogConnection!
  • }