Collaboration

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, prospect\_and\_customer, 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 the Firehose Overview article for more details on request and response formats and parameters.

Action

GET /v3/collaborations/stream

Examples

Read the stream of collaboration events

GET /v3/collaborations/stream?position=tail
Accept: application/json
Authorization: Bearer $ACCESS_TOKEN
User-Agent: $CLIENT_NAME

HTTP/1.1 200 OK
   Content-Type: application/json

{
  "items": [
    {
      "data": {
        "collaborator_id": 1267518,
        "created_at": "2017-12-14T14:09:32Z",
        "creator_id": 1267517,
        "id": 1046133,
        "resource_id": 1942366241,
        "resource_type": "lead"
      },
      "meta": {
        "event_cause": "interaction",
        "event_id": "SXz0V7piSu6d410bp8TOXw",
        "event_time": "2017-12-14T14:09:32Z",
        "event_type": "created",
        "sequence": 1,
        "type": "collaboration"
      }
    }
  ],
  "meta": {
    "links": {
      "next": "https://api.getbase.com/v3/collaborations/stream?position=ZmlyZWhvc2UuY29sbGFib3JhdGlvbi5ieV9hY2NvdW50LDMsNDY3NjA="
    },
    "position": "ZmlyZWhvc2UuY29sbGFib3JhdGlvbi5ieV9hY2NvdW50LDMsNDY3NjA=",
    "top": true
  }
}