Webhook type
The webhook type is a descriptive string composed of three parts: subject, attribute, and verb. The subject is what the event happened to, either a contract, a data field, a participant, a party, or a product. The attribute is optional if the event only happened to a specific part of the subject. The verb describes what happened to the subject.
The table below gives a brief overview of each webhook type. You can get more information about the event using the contract event_ID in our Contract event endpoint. Please see the Contract event model section to learn more about each event.
Note:
We are constantly working on creating new contract events and updating the list below.
| Type | Description |
|---|---|
contract:content_update | The contract's content has been updated after being sent to the counterparty. |
contract:decline | The contract state has been changed to declined. |
contract:delete | A contract has been deleted. |
contract:lifecycle_state:cancel | The signed and recurring contract has been canceled. |
contract:lifecycle_state:end | The contract has expired, and its lifecycle state has been changed to ended. This event is triggered only if the contract has come to a natural end and has not been canceled or terminated. |
contract:lifecycle_state:new_period | The contract entered a new period. |
contract:lifecycle_state:start | The contract began its first period, and its lifecycle state was changed to active. |
contract:lifecycle_state:terminate | The contract was terminated, and its lifecycle state was changed to ended. |
contract:publish | The contract state has changed from draft to pending. |
contract:sign | The contract state has changed to signed. |
contract:signature_reset | The signatures in the contract were reset when the contract was changed after one or more signatories had signed it. |
contract:signing_period_expire | The period during which the contract was supposed to be signed has expired, so its state changed to overdue. |
contract:signing_period_revive | Another period during which the contract is supposed to be signed has begun, so its state changed to pending. |
comment:create | A comment has been added to the contract. |
data_field:update | The attributes of a data field have been updated. |
participant:create | A participant has been added to the contract. |
participant:decline | A participant has declined the contract. |
participant:delegate | A participant has been delegated. |
participant:delete | A participant has been deleted. |
participant:delivery_failure | A participant failed to get an invitation to the contract. |
participant:first_visit | A participant opened the contract for the first time. |
participant:publish | A participant received access to the contract. |
participant:sign | A participant has signed the contract. |
participant:signature_reset | A participant's signature was reset when a change was made to the contract after the participant had signed it. |
participant:update | The attributes of a participant have been updated. |
party:create | A party has been added to the contract. |
party:delete | A party has been removed from the contract. |
party:update | The attributes of a party have been updated. |
product:create | A product has been added to the contract. |
product:delete | A product has been removed from the contract. |
product:update | The attributes of a product have been updated. |
Updated about 1 year ago