Webhook Fields
Important: If the trigger field is populated as part of a new record creation, the change type displays as "created." If the entire record is deleted, the change displays as "deleted." If the record exists and the trigger field is populated, updated, or cleared, the change type always displays as "updated." To receive alerts on a field level (for example, email address is erased) be sure to set Trigger on Update to Yes.
Note: Refer to Foreign Keys by their proper field name regardless of appearance on record. In many cases, this means appending the field with "_ID". For example, if Martial Status is used as a Trigger Field on a Contact Record, the proper field would be Martial_Status_ID.
- Display Name
- A short, descriptive title.
- Description
- A place to add pertinent information such as an overview of how the Webhook will be triggered.
- Http Method
- GET or POST
- Uri Template
- The endpoint where a payload will be delivered.
- Body Template
- The following tokens are supported using standard JSON formatting (optionally a constant value may also be defined):
- dp_RecordID
- dp_UserID
- dp_AuditType
- Headers Template
- An optional header which may be included in the payload.
- Trigger Fields
- Fields listed here further qualify what must change on a record to trigger the Webhook. If left blank, changes to any field on the record will trigger the Webhook. Formatting should exclude table names and brackets. Multiple fields can be separated by commas. For example: Display_Name, Date_of_Birth, Email_Address.
- Dependent Condition
- If the Process should not be invoked for all Records on this Page, specify field values here. Values should be formatted as part of the WHERE clause. For example: __Age >= 18 AND Email_Address IS NOT NULL. Table Lookup Convention is NOT supported.Note: Any records you reference in the Dependent Condition must exist when the Webhook is invoked. For example, let's say a Webhook is triggered on the Form_Response. If the Dependent Condition references a Form_Response_Answer, the Webhook will not trigger because the Form_Response_Answer records may not exist for that Form_Response yet.
- Trigger on Create
- Set as Yes or No to determine whether this Webhook should be invoked by newly created records.
- Trigger on Update
- Set as Yes or No to determine whether this Webhook should be invoked when the value of a Trigger Field is updated.
- Trigger on Delete
- Set as Yes or No to determine whether this Webhook should be invoked when a record is deleted.
- Max Retries
- Define the maximum number of attempts to trigger the Webhook before termination. One attempt will be tried per minute.
- Active
- Must be true for the Webhook to execute.
- Table Name
- The Table to which this Webhook applies. Changes made to records in this Table through the REST api will trigger the Webhook.