Log events

Last updated June 17, 2020

PUT  /automation/v3/logevents/workflows/:workflowId/filter

Note: This endpoint is deprecated. See this post for more details

Method Details

HTTP Methods:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Get a history of events for a specific workflow, filtered for a specific contact and/or event type(s).

This endpoint is particularly useful for integrations that pull data on a contact and display them in an application, like a CRM or Support Desk integration.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.		 Used to authenticate the request. Please see this page for more details about authentication.
Workflow ID Used in the request URL The ID of the workflow you wish to see metadata for.
Filter JSON Used in the request body This JSON represents the desired Contact VID, and/or the list of event types. You can include multiple filter types, but you must include at least one filter type. See the examples for more details.
Optional Parameters How to use Description
Offset &offset=X - UTC millis The date in which the resultset cursor should start from, time descending. Defaults to current time.
Limit Date &limitDate=X - UTC millis The earliest date of an event that will be return from the resultset. Defaults to 180 days in the past from current time.

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example PUT URL: https://api.hubapi.com/automation/v3/logevents/workflows/10900/filter?hapikey=demo You can request the log events in the workflow for a specific contact vid by providing a vid filter like the following. It will return all event types found for that vid, in descending order from most recent to oldest. { "vid": 34 } You can also use a "types" filter like the following to restrict the response by desired event types. This example does not restrict the response to a specific vid, but will retrieve results for all recent contacts. { "types": [ "COMPLETED_WORKFLOW" ] } You can combine these filter types to restrict the returned log events to a specific vid and set of event types. For example, using the following filters: { "vid": 34, "types": [ "ENROLLED", "COMPLETED_WORKFLOW" ] } Could produce a response such as: { "objects": [ { "time": 1464184187110, "logEventName": "COMPLETED_WORKFLOW", "contactName": "John Doe", "workflowId": 1234, "workflowName": "My Test Workflow", "vid": 34, "isCanonicalVid": true, "stepId": 55555, "isEnrollmentTest": false, "severity": "INFO" }, { "time": 1464184185917, "logEventName": "ENROLLED", "contactName": "John Doe", "workflowId": 1234, "workflowName": "My Test Workflow", "vid": 34, "isCanonicalVid": true, "stepId": 0, "isEnrollmentTest": false, "triggerSet": [ { "id": "5678", "type": "SEGMENT" } ], "severity": "INFO" } ], "limit": 1451078260131, "offset": 1464184185917, "size": 2 }