Contract event
Any action or a change in a contract content creates a contract event.
Contract events are also the basis for triggering webhooks. See the Webhook type section for information on the types and format of contract events.
The events are grouped by the entity on which the event occurs. For example, a contract:delete event is created when a contract is deleted, while a party:delete event is created when a party is deleted. See the Contract event type chapter that follows.
Contract event attributes
| Attribute | Type | Description |
|---|---|---|
| _links | object | Contains links to endpoints associated with the parent object. See Links. |
| actor | object or null | Indicates the participant in the contract event. See Actor. |
| created_time | string(datetime) | The time the contract event was created. |
| data | object | Details of the action or change that created the event. See Data. |
| id | integer(signed_integer_id) | The ID of the contract event. |
| type | string(enum) | The type of the contract event. See Contract event type |
Actor
The actor object shows which participant performed the action or change that led to the event being created.
| Attribute | Type | Description |
|---|---|---|
| id | integer(signed_integer_id) | The ID of the participant. |
| name | string | The name of the participant. |
| party | object | The party of the participant. See Actor party. |
Actor party
| Attribute | Type | Description |
|---|---|---|
| id | integer(signed_integer_id) | The ID of the party. |
| name | string | The name of the party. |
Data
| Attribute | Type | Description |
|---|---|---|
| changes | array[object] | Details about the changes made to the contract that created the event. See Contract event data changes. |
| subject | object | Indicates the subject of the contract event data changes. See Comment, Contract, Data field, Participant, Party, Product. |
Contract event data changes
The contract event data changes array attributes are available only for update-related events.
Subject
The entity that is the subject of the event. The type of the subject depends on the event and can be determined by looking at the event type. One of the following depends on the event type:
Comment
| Attribute | Type | Description |
|---|---|---|
| contract_id | integer(signed_integer_id) | The ID of the contract that comment exists. |
| id | integer(signed_integer_id) | The ID of the comment. |
Contract
| Attribute | Type | Description |
|---|---|---|
| id | integer(signed_integer_id) | The ID of the contract |
Data field
| Attribute | Type | Description |
|---|---|---|
| contract_id | integer(signed_integer_id) | The ID of the contract that data field exists. |
| custom_id | string | The custom ID of the data field. |
| id | integer(signed_integer_id) | The ID of the data field. |
| name | string | The name of the data field. |
Participant
| Attribute | Type | Description |
|---|---|---|
| id | integer(signed_integer_id) | The ID of the participant. |
| name | string | The name of the participant. |
| party | object | The party of the participant. See Party |
Party
| Attribute | Type | Description |
|---|---|---|
| id | integer(signed_integer_id) | The ID of the party. |
| name | string | The name of the party. |
Product
| Attribute | Type | Description |
|---|---|---|
| id | integer(signed_integer_id) | The ID of the product. |
| name | string | The name of the product. |
Contract event type
Note:
We are constantly working on creating new contract events and updating the list below.
Currently, we support the following event types:
Contract
- contract:content_update
- contract:decline
- contract:delete
- contract:lifecycle_state:cancel
- contract:lifecycle_state:end
- contract:lifecycle_state:new_period
- contract:lifecycle_state:start
- contract:lifecycle_state:terminate
- contract:publish
- contract:sign
- contract:signature_reset
- contract:signing_period_expire
- contract:signing_period_revive
Comment
- comment:create
Data field
- data_field:update
Participant
- participant:create
- participant:decline
- participant:delegate
- participant:delete
- participant:delivery_failure
- participant:first_visit
- participant:publish
- participant:sign
- participant:signature_reset
- participant:update
Party
- party:create
- party:delete
- party:update
Product
- product:create
- product:delete
- product:update
Updated 5 months ago