v49

latestOpenAPI 3.0.0raw.githubusercontent.com2024-12-22168107389.8 KB
events

List Events

get/events

Query parameters

pagenumber
limitnumber

Response

id_eventstring required

Unique identifier for the event

id_connectionstring required

Connection ID associated with the event

id_projectstring required

Project ID associated with the event

type'crm.contact.created' | 'crm.contact.pulled' | 'crm.company.created' | 'crm.company.pulled' | 'crm.deal.created' | 'crm.deal.pulled' | 'crm.engagement.created' | 'crm.engagement.pulled' | 'crm.note.created' | 'crm.note.pulled' | 'crm.stage.pulled' | 'crm.task.pulled' | 'crm.task.created' | 'crm.user.pulled' | 'ticketing.ticket.created' | 'ticketing.ticket.pulled' | 'ticketing.comment.created' | 'ticketing.comment.pulled' | 'ticketing.attachment.created' | 'ticketing.attachment.pulled' | 'ticketing.collection.pulled' | 'ticketing.account.pulled' | 'ticketing.contact.pulled' | 'ticketing.tag.pulled' | 'ticketing.team.pulled' | 'ticketing.user.pulled' | 'ats.activity.created' | 'ats.activity.pulled' | 'ats.application.created' | 'ats.application.pulled' | 'ats.attachment.created' | 'ats.attachment.pulled' | 'ats.candidate.created' | 'ats.candidate.pulled' | 'ats.department.pulled' | 'ats.eecos.pulled' | 'ats.interview.created' | 'ats.interview.pulled' | 'ats.job.pulled' | 'ats.jobinterviewstage.pulled' | 'ats.offer.created' | 'ats.office.pulled' | 'ats.rejectreason.pulled' | 'ats.scorecard.pulled' | 'ats.tag.pulled' | 'ats.user.pulled' | 'filestorage.file.created' | 'filestorage.file.pulled' | 'filestorage.folder.created' | 'filestorage.folder.pulled' | 'filestorage.group.pulled' | 'filestorage.user.pulled' | 'filestorage.drive.pulled' | 'filestorage.permission.pulled' | 'filestorage.sharedlink.pulled' | 'connection.created' required

Scope of the event

status'success' | 'fail' required

Status of the event

directionstring required

Direction of the event

method'GET' | 'POST' | 'PUT' | 'DELETE' required

HTTP method used for the event

urlstring required

URL associated with the event

providerstring required

Provider associated with the event

timestampstring date-time required

Timestamp of the event

id_linked_userstring required

Linked user ID associated with the event

Example response

[
  {
    "id_event": "123e4567-e89b-12d3-a456-426614174000",
    "id_connection": "123e4567-e89b-12d3-a456-426614174001",
    "id_project": "123e4567-e89b-12d3-a456-426614174002",
    "type": "connection.created",
    "status": "success",
    "direction": "0",
    "method": "POST",
    "url": "/crm/companies",
    "provider": "hubspot",
    "timestamp": "2024-10-01T12:00:00Z",
    "id_linked_user": "123e4567-e89b-12d3-a456-426614174003"
  }
]