Collaborations

This endpoint delivers stream of collaboration events. When user is added as a collaborator to the resource, such as deal, lead or contact, Firehose will emit collaboration created event. When user is removed from collaborators, Firehose will emit collaboration deleted event.

Supported collaboration attributes:

Attribute Type Description
id number Unique identifier of the collaboration.
creator_id number Unique identifier of the user that created the collaboration.
collaborator_id number Unique identifier of the user that is a collaborator of the resource.
resource_id number Unique identifier of the resource the collaboration is attached to.
resource_type string Type name of the resource the collaboration is attached to.
Possible values:
  • lead
  • contact
  • prospectandcustomer
  • deal
created_at string Date and time that the collaboration was created in UTC (ISO8601 format).

Endpoints

Stream Collaborations

Read the stream of collaboration events.

See Overview article for more details on request and response formats and parameters.