Relation Delete
Overview
This webhook response is triggered when an existing relation between objects is deleted.
For example, in a business management system, a company may want to remove an relation between a custom object record and a contact. In this case:
- The first object (custom object record) could represent an entity such as a project or a transaction.
- The second object (contact) would represent a person associated with the custom object.
Schema
The webhook response follows the JSON schema below:
id
stringfirstObjectKey
stringfirstRecordId
stringsecondObjectKey
stringsecondRecordId
stringassociationId
stringlocationId
stringField Descriptions
id
id- Type:
string - Unique identifier for the deleted association.
firstObjectKey
firstObjectKey- Type:
string - Key representing the first object in the association.
firstRecordId
firstRecordId- Type:
string - Identifier of the first object’s specific record.
secondObjectKey
secondObjectKey- Type:
string - Key representing the second object in the association.
secondRecordId
secondRecordId- Type:
string - Identifier of the second object’s specific record.
associationId
associationId- Type:
string - Unique identifier for the association that was deleted.
locationId
locationId- Type:
string - Identifies the location associated with the deleted association.
Example Response
{"id": "67ae0d741119d218c9d0c477","firstObjectKey": "custom_objects.mad","firstRecordId": "67a349a79b28947ec1f65bb5","secondObjectKey": "contact","secondRecordId": "emqfhnG3g9D9chy9inTz","associationId": "669e5795add2094075906c65","locationId": "eHy2cOSZxMQzQ6Yyvl8P"}
Additional Notes
- The
firstObjectKeyandsecondObjectKeydefine the relationship between the deleted entities.