Versions Compared

Key

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

Name

Type

Description

id

String

The ID of the retrieved webhook request

number

String

The number of the retrieved webhook request

life_cycle_stateString

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

entityString

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

  • ACCOUNTSRECEIVABLE
  • ACTIVITIES
  • CONTACTINFORMATION
  • CREDITNOTES

  • INVOICES

  • INVOICECANCELLATIONS

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


entity_idStringThe ID of the entity that was communicated through the webhook request
urlStringThe URL that was used by the webhook to send the information
authentication_codeStringThe code that will be used for authentication purposes. The code is a HMAC (Hash Message Authentication Code) generated using the data json object and the secret key selected on the related definition
fields_setStringThe fields set that was used by the webhook to send the information
requestJSON ObjectThe request that was send by the webhook
responseJSON ObjectThe response that was received by the webhook
error_codeStringThe code of the error that occurred while sending the webhook request. This is applicable only for rejected webhook request
error_descriptionStringThe description of the error that occurred while sending the webhook request. This is applicable only for rejected webhook request
webhook_definitionWebhook Definition ObjectThe webhook definition that was used to send the webhook request
workflow_ruleWorkflow Rule ObjectThe workflow rule that triggered the webhook request
log_informationLog Information ObjectThe log information of the retrieved webhook request

...