Reminder: As of August 9th, the demo API key will only be allowed to make GET requests. Please see the announcement for more details.

Using webhooks in workflows

Last updated June 3, 2019

Notes:
  • The webhooks used in workflows are completely separate from the webhooks sent for an OAuth app that would be managed through the Webhooks API. For more details about that type of webhook, please see the documentation here.
  • Webhook actions are only available with an Enterprise subscription. See this article for more details.

For more details on setting up a webhook action in a workflow, see this knowledge article.

The webhook will POST the data for the contact going through the workflow. The data will be the exact same data you'd get when pulling that contact using the Contacts API.

Webhooks follow these rules for connecting and retrying requests:

  • Workflows waits up to 3 seconds to connect to a tcp socket, if this fails we will retry.
  • Workflows waits up to 30 seconds for a response (aka request timeout).
  • Workflows will not retry after receiving 4XX series response status codes.
    • One exception to this rule is 429 rate limit errors; workflows will automatically retry after receiving a 429 response, and will respect the Retry-After header if present.
  • Workflows will retry after receiving a 5xx series error.
    • When we encounter a 5xx error, the request will be retried over the next 3 days before failing permanently.
  • Workflows will issue webhook attempts at up to 20 requests per second.

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
The webhook request contains the data for the contact record going through the workflow. Example Request data: { "vid": 71, "canonical-vid": 71, "portal-id": 62515, "profile-token": "AO_T-mMZs-n9xi4QD7dSSPBnLcWSFuLlza0RH7r5EI12UMul8pXi1bhuR71bsusug6f31W9KKfOntz1jUCfrS2QE18gCk_74Dkip4GUsgxKyk7A0uNGtrCYmRm4ZhR0ThUONh2PglE8R", "profile-url": "https://app.hubspot.com/contacts/62515/lists/public/contact/_AO_T-mMZs-n9xi4QD7dSSPBnLcWSFuLlza0RH7r5EI12UMul8pXi1bhuR71bsusug6f31W9KKfOntz1jUCfrS2QE18gCk_74Dkip4GUsgxKyk7A0uNGtrCYmRm4ZhR0ThUONh2PglE8R/", "properties": { "hs_social_linkedin_clicks": { "value": "0", "versions": [ { "value": "0", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1345568681004, "selected": false } ] }, "first_conversion_event_name": { "value": "testform: testform", "versions": [ { "value": "testform: testform", "source-type": "CALCULATED", "source-id": null, "source-label": null, "timestamp": 0, "selected": false } ] }, "hs_social_num_broadcast_clicks": { "value": "0", "versions": [ { "value": "0", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1348921921004, "selected": false } ] }, "hs_social_facebook_clicks": { "value": "0", "versions": [ { "value": "0", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1345568681004, "selected": false } ] }, "createdate": { "value": "1325634178632", "versions": [ { "value": "1325634178632", "source-type": "MIGRATION", "source-id": null, "source-label": null, "timestamp": 1325634621005, "selected": false } ] }, "hs_analytics_revenue": { "value": "0.0", "versions": [ { "value": "0.0", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1364105130004, "selected": false } ] }, "lastname": { "value": "perf_user_970", "versions": [ { "value": "perf_user_970", "source-type": "MIGRATION", "source-id": null, "source-label": null, "timestamp": 1325634621005, "selected": false }, { "value": "perf_user_970", "source-type": "FORM", "source-id": "2e137f47a86e48798322d47f6f529a93", "source-label": "LastName", "timestamp": 1325633423003, "selected": false } ] }, "hs_analytics_first_url": { "value": "", "versions": [ { "value": "", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1345568681004, "selected": false } ] }, "ipaddress": { "value": "unknown", "versions": [ { "value": "unknown", "source-type": "MIGRATION", "source-id": null, "source-label": null, "timestamp": 1325634621005, "selected": false }, { "value": "unknown", "source-type": "FORM", "source-id": "2e137f47a86e48798322d47f6f529a93", "source-label": "IPAddress", "timestamp": 1325633423003, "selected": false } ] }, "lastmodifieddate": { "value": "1366074891080", "versions": [ { "value": "1366074891080", "source-type": "CALCULATED", "source-id": null, "source-label": null, "timestamp": 1366074891013, "selected": false } ] }, "hs_analytics_num_event_completions": { "value": "0", "versions": [ { "value": "0", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1348921921004, "selected": false } ] }, "hs_analytics_first_referrer": { "value": "", "versions": [ { "value": "", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1345568681004, "selected": false } ] }, "hs_analytics_source": { "value": "DIRECT_TRAFFIC", "versions": [ { "value": "DIRECT_TRAFFIC", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1354416847004, "selected": false }, { "value": "OFFLINE", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1345568681004, "selected": false } ] }, "hs_social_google_plus_clicks": { "value": "0", "versions": [ { "value": "0", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1348921921004, "selected": false } ] }, "hs_analytics_num_page_views": { "value": "0", "versions": [ { "value": "0", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1345568681004, "selected": false } ] }, "hs_analytics_last_timestamp": { "value": "0", "versions": [ { "value": "0", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1364105130004, "selected": false }, { "value": "1325633423000", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1348921921004, "selected": false }, { "value": "1325634178632", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1345568681004, "selected": false } ] }, "hs_analytics_first_timestamp": { "value": "1325633423000", "versions": [ { "value": "1325633423000", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1345568681004, "selected": false } ] }, "num_conversion_events": { "value": "1", "versions": [ { "value": "1", "source-type": "CALCULATED", "source-id": null, "source-label": null, "timestamp": 0, "selected": false } ] }, "hs_analytics_source_data_2": { "value": "", "versions": [ { "value": "", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1345568681004, "selected": false } ] }, "hs_analytics_source_data_1": { "value": "", "versions": [ { "value": "", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1345568681004, "selected": false } ] }, "hs_analytics_last_visit_timestamp": { "value": "1325633423000", "versions": [ { "value": "1325633423000", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1348921921004, "selected": false } ] }, "hs_analytics_num_visits": { "value": "0", "versions": [ { "value": "0", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1345568681004, "selected": false } ] }, "hs_analytics_last_referrer": { "value": "", "versions": [ { "value": "", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1345568681004, "selected": false } ] }, "hs_analytics_last_url": { "value": "", "versions": [ { "value": "", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1345568681004, "selected": false } ] }, "recent_conversion_event_name": { "value": "testform: testform", "versions": [ { "value": "testform: testform", "source-type": "CALCULATED", "source-id": null, "source-label": null, "timestamp": 0, "selected": false } ] }, "first_conversion_date": { "value": "1325633423000", "versions": [ { "value": "1325633423000", "source-type": "CALCULATED", "source-id": null, "source-label": null, "timestamp": 0, "selected": false } ] }, "hs_social_twitter_clicks": { "value": "0", "versions": [ { "value": "0", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1345568681004, "selected": false } ] }, "firstname": { "value": "perf_user_970", "versions": [ { "value": "perf_user_970", "source-type": "MIGRATION", "source-id": null, "source-label": null, "timestamp": 1325634621005, "selected": false }, { "value": "perf_user_970", "source-type": "FORM", "source-id": "2e137f47a86e48798322d47f6f529a93", "source-label": "FirstName", "timestamp": 1325633423003, "selected": false } ] }, "hs_analytics_average_page_views": { "value": "0", "versions": [ { "value": "0", "source-type": "ANALYTICS", "source-id": null, "source-label": null, "timestamp": 1364912952004, "selected": false } ] }, "recent_conversion_date": { "value": "1325633423000", "versions": [ { "value": "1325633423000", "source-type": "CALCULATED", "source-id": null, "source-label": null, "timestamp": 0, "selected": false } ] }, "lifecyclestage": { "value": "lead", "versions": [ { "value": "lead", "source-type": "MIGRATION", "source-id": null, "source-label": null, "timestamp": 1325634621005, "selected": false } ] }, "email": { "value": "perf_user_970@test.com", "versions": [ { "value": "perf_user_970@test.com", "source-type": "MIGRATION", "source-id": null, "source-label": null, "timestamp": 1325634621005, "selected": false } ] } }, "form-submissions": [ { "conversion-id": "2e137f47a86e48798322d47f6f529a93", "timestamp": 1325633423000, "form-id": "762987228e694ef19530f58da2db5f63", "portal-id": 62515, "page-title": "testform", "title": "testform" } ], "list-memberships": [ ], "identity-profiles": [ { "vid": 71, "identities": [ { "type": "LEAD_GUID", "value": "8a706adf34a5ee0d0134a5f44e4a01c8", "timestamp": 1325634178632 }, { "type": "EMAIL", "value": "perf_user_970@test.com", "timestamp": 1325634178632 } ] } ] }