Collaboration Request
This endpoint delivers stream ofcollaboration_requestevents. When user requested collaboration to the resource, such as deal, lead or contact, Firehose will emitcollaboration_requestcreatedevent. When user's request is approved or denied, Firehose will emitcollaboration_requestupdateevent.
Supported collaboration request attributes:
| Attribute | Type | Description |
|---|---|---|
id |
number | Unique identifier of the collaboration request. |
user_id |
number | Unique identifier of the user that collaboration request was created for. |
status |
string | Status of request. Possible values:pending,approved,denied` |
resource_id |
number | Unique identifier of the resource that was requested to collaborate on. |
resource_type |
string | Type name of the resource that was requested to collaborate on. Possible values:lead,contact,prospect_and_customer,deal |
created_at |
string | Date and time that the collaboration request was created in UTC (ISO8601 format). |
Endpoints
Stream Collaboration Requests
Read the stream of collaboration_request events.
SeeIntroductionarticle for more details on request and response formats and parameters.
Action
GET /v3/collaboration_requests/stream
Examples
Read the stream of collaboration request events
GET /v3/collaboration_requests/stream?position=tailAccept: application/jsonAuthorization: Bearer $ACCESS_TOKENUser-Agent: $CLIENT_NAME
HTTP/1.1200OKContent-Type:application/json{"items":[{"data":{"id":380,"user_id":1099394,"resource_type":"contact","resource_id":17287699,"created_at":"2018-06-13T09:04:24Z","status":"pending"},"meta":{"event_cause":"interaction","sequence":1,"event_id":"h8QzpWRpQL-HnX2kJ93kSA","event_type":"created","type":"collaboration_request","event_time":"2018-06-13T09:04:24Z"}}],"meta":{"links":{"next":"https://api.getbase.com/v3/collaboration_requests/stream?position=ZmlyZWhvc2UuY29sbGFib3JhdGlvbl9yZXF1ZXN0LmJ5X2FjY291bnQsMCwyNQ=="},"position":"ZmlyZWhvc2UuY29sbGFib3JhdGlvbl9yZXF1ZXN0LmJ5X2FjY291bnQsMCwyNQ==","top":true}}