Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Name

Type

Description

id

String

The ID of the retrieved alert

number

String

The number of the retrieved alert

life_cycle_stateString

The life cycle state of the retrieved alert which can be SUCCESSFUL or REJECTED

typeStringThe type of the retrieved alert which can be EMAIL or SMS
entityString

The name of the entity that was communicated through the alert. The supported entities are the following:

  • ACCOUNTSRECEIVABLE
  • ACTIVITIES
  • CONTACTINFORMATION
  • CREDITNOTES

  • INVOICES

  • INVOICECANCELLATIONS

  • JOBS
  • LEADS
  • PAYMENTS
  • PAYMENTCANCELLATIONS
  • REFUNDREFUNDS
  • REWARDOFFERS
  • SERVICEREQUESTS
  • SUBSCRIPTIONS
  • WALLETS
  • WALLETTRANSACTIONS
  • WRITEOFFS
Tip
  • REWARDOFFERS entity is available from CRM.COM R11.0.0
  • LEADS entity is available from CRM.COM R14.0.0
  • ACCOUNTSRECEIVABLE, CONTACTINFORMATION, REWARDOFFERS, CREDITNOTES, INVOICES, INVOICECANCELLATIONS, PAYMENTS, PAYMENTCANCELLATIONS, REFUNDS, WRITEOFFS, WALLETS, WALLETTRANSACTIONS are available from CRM.COM R14.1.0


entity_idStringThe ID of the entity that was communicated through the alert
subjectString

The subject of the retrieved alert. This is applicable only if the type is EMAIL

contentStringThe content of the retrieved alert
recipient_email_addressStringThe email address of the recipient. This is applicable only if the type is EMAIL
recipient_phone_numberNumberThe phone number of the recipient. This is applicable only if the type is SMS
error_codeStringThe code of the error that occurred while sending the alert. This is applicable only for rejected alerts
error_descriptionStringThe description of the error that occurred while sending the alert. This is applicable only for rejected alerts
recipientUser ObjectThe recipient user of the retrieved alert
alert_definitionAlert Definition ObjectThe alert definition that was used to send the alert
workflow_ruleWorkflow Rule ObjectThe workflow rule that triggered the alert
log_informationLog Information ObjectThe log information of the retrieved alert

...