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

AttributeTypeDescription
_linksobjectContains links to endpoints associated with the parent object. See Links.
actorobject or nullIndicates the participant in the contract event. See Actor.
created_timestring(datetime)The time the contract event was created.
dataobjectDetails of the action or change that created the event. See Data.
idinteger(signed_integer_id)The ID of the contract event.
typestring(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.

AttributeTypeDescription
idinteger(signed_integer_id)The ID of the participant.
namestringThe name of the participant.
partyobjectThe party of the participant. See Actor party.

Actor party

AttributeTypeDescription
idinteger(signed_integer_id)The ID of the party.
namestringThe name of the party.

Data

AttributeTypeDescription
changesarray[object]Details about the changes made to the contract that created the event. See Contract event data changes.
subjectobjectIndicates the subject of the contract event data changes. See Contract, Party, Participant.

Contract event data changes

The contract event data changes array attributes are available only for update-related events.

AttributeTypeDescription
attributestringThe name of the changed attribute, such as “name”, “email” or “value”.
fromstringThe value of the attribute before the change.
tostringThe value of the attribute after the change.

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:

Contract

AttributeTypeDescription
idinteger(signed_integer_id)The ID of the contract.

Party

AttributeTypeDescription
idinteger(signed_integer_id)The ID of the party.
namestringThe name of the party.

Participant

AttributeTypeDescription
idinteger(signed_integer_id)The ID of the participant.
namestringThe name of the participant.
partyobjectThe party of the participant. See Party

Product

AttributeTypeDescription
idinteger(signed_integer_id)The ID of the product.
namestringThe 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

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