{"info":{"_postman_id":"27778dfe-8df1-4b1b-88de-c7a1e3dd5ea6","name":"SmartReach Documentation","description":"

SmartReach uses webhooks to notify your application when an event happens in your account. You can use webhooks to sync activity in your SmartReach with any other tools (internal CRMs etc) that you may be using.

\n

To setup webhooks,

\n
    \n
  1. go to Settings -> Webhook Settings in your SmartReach account
    2. \n
  2. create a new webhook -> provide the webhook Endpoint URL.
    3. \n
  3. In the next step, select the Events that should trigger this webhook
    4. \n
  4. click Save, and then click \"Start Webhook\"
    5. \n
  5. When any of the selected events happens in your SmartReach account, it will make a POST HTTP request with the webhook data to the webhook Endpoint URL. (NOTE: Webhooks are shared across your team in SmartReach.)
    6. \n
\n

Read below for the list of supported events, and the object data structure for each of those events.

\n

If you have any questions, reach out to us via email: support@smartreach.io

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"9575627","collectionId":"27778dfe-8df1-4b1b-88de-c7a1e3dd5ea6","publishedId":"SzS1SoR4","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-03-11T21:43:40.000Z"},"item":[{"name":"Prospects","item":[],"id":"29654e38-ae90-4f3e-8421-1f483b3761da","description":"

Prospect Object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
prospect_idnumberUnique ID of prospect in SmartReach account
emailstringProspect's email
first_namestringProspect's first name
last_namestringProspect's last name
liststringList in which prospect belongs
companystringProspect's company
citystringProspect's city
countrystringProspect's country
timezonestringProspect's timezone
prospect_categorystringProspect's category
created_atnumberCreated at time (in milliseconds after UTC)
custom_fieldsjsonJson object with all the custom fields added for the prospect
\n

Prospect Object Example

\n
{\n    \"prospect_id\": 7419929,\n    \"email\": \"john@doe.com\n    \"first_name\": \"John\",\n    \"last_name\": \"Doe\",\n    \"created_at\": 1583580438532,\n    \"custom_fields\": {\n        \"website\": \"www.example.com\"\n    },\n    \"list\": \"India\",\n    \"company\": \"\",\n    \"city\": \"Hyderabad\",\n    \"country\": \"\",\n    \"timezone\": 'Asia/Kolkata',\n    \"prospect_category\": \"Not categorized\"\n}\n
\n","event":[{"listen":"prerequest","script":{"id":"43b0510f-a63f-4476-a33b-fd63f38ed57a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8bb77d42-cedf-4374-82b4-d7c4d21d1265","type":"text/javascript","exec":[""]}}],"_postman_id":"29654e38-ae90-4f3e-8421-1f483b3761da"},{"name":"Activity","item":[],"id":"6c5ec5bb-63ef-436b-9b62-d98291476b5e","description":"

Activity Object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
created_atnumberCreated at time (milliseconds after UTC)
email_bodystringEmail body (html)
email_text_bodystringEmail body (text)
email_subjectstringEmail body (text)
email_fromstringFrom email address
email_tostringTo email address
campaign_namestringCampaign in which activity happened
campaign_step_namestringCampaign step in which activity happened
clicked_urlstringClicked url (link_clicked event)
\n

Activity Object Example

\n
{\n    \"prospect_id\": 7419929,\n    \"email\": \"john@doe.com\n    \"first_name\": \"John\",\n    \"last_name\": \"Doe\",\n    \"created_at\": 1583580438532,\n    \"custom_fields\": {\n        \"website\": \"www.example.com\"\n    },\n    \"list\": \"India\",\n    \"company\": \"\",\n    \"city\": \"Hyderabad\",\n    \"country\": \"\",\n    \"timezone\": 'Asia/Kolkata',\n    \"prospect_category\": \"Not categorized\"\n}\n
\n","event":[{"listen":"prerequest","script":{"id":"43b0510f-a63f-4476-a33b-fd63f38ed57a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8bb77d42-cedf-4374-82b4-d7c4d21d1265","type":"text/javascript","exec":[""]}}],"_postman_id":"6c5ec5bb-63ef-436b-9b62-d98291476b5e"},{"name":"Events","item":[],"id":"92c4d920-524f-4716-9e6f-36e5bdd29d5a","description":"

Supported events

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
EventDescriptionObjects in Event Data
prospect.createdOccurs when a prospect is createdProspect
prospect.updatedOccurs when a prospect is updatedProspect
prospect.created_or_updatedOccurs when a prospect is created or updatedProspect
activity.email.sentOccurs when a email is sentProspect, Activity
activity.email.bouncedOccurs when a email bouncesProspect, Activity
activity.email.openedOccurs when a email bouncesProspect, Activity
activity.email.link_clickedOccurs when a link is clicked in any emailProspect, Activity
activity.email.invalidOccurs when a email is marked as invalidProspect, Activity
activity.email.repliedOccurs when a new reply (from a prospect) is foundProspect, Activity
activity.email.auto_repliedOccurs when a auto-reply is foundProspect, Activity
activity.email.out_of_office_repliedOccurs when a Out of Office reply is foundProspect, Activity
activity.prospect.opted_outOccurs when a prospect opts-out / unsubscribesProspect, Activity
activity.prospect.completed_campaignOccurs when a prospect is marked as completed in a campaignProspect, Activity
\n
","event":[{"listen":"prerequest","script":{"id":"b4028a79-f5c6-4116-a7e1-bc285aafc9c3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7c1204eb-344a-47b8-a68e-efa2cd880f49","type":"text/javascript","exec":[""]}}],"_postman_id":"92c4d920-524f-4716-9e6f-36e5bdd29d5a"},{"name":"Webhooks","item":[],"id":"e5642680-3b05-44f5-9767-ea7bf159d3c5","description":"

Webhook Object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
metadatajsonSee the attributes in the following lines
metadata.event_typestringEvent name
metadata.versionstringWebhook Version (currently \"v2\")
metadata.webhook_idnumberUnique webhook identifier in your SmartReach account
metadata.webhook_urlstringURL which gets triggered by this webhook
metadata.received_atnumberTimestamp at which event/webhook was triggered
dataArray of json objectsArray of objects containing the Event Data
\n

Webhook Example Object

\n
{\n  \"metadata\": {\n    \"event_type\": \"email_opened\",\n    \"version\": \"v2\",\n    \"webhook_id\": 1243434,\n    \"webhook_url\": \"https://example.com/hooks\"\n    \"received_at\": 1583554968592\n  },\n  \"data\": [\n    {\n      \"prospect\": {\n        \"prospect_id\": 536,\n        \"prospect_email\": \"pbsamant1@gmail.com\",\n        \"first_name\": \"Prateeksha\",\n        \"last_name\": \"Samant\",\n        \"list\": \"Test_campaign_specific_\",\n        \"company\": \"saddahaq\",\n        \"city\": \"hyderabad\",\n        \"country\": \"India\",\n        \"timezone\": \"Asia/Kolkata\",\n        \"prospect_category\": \"Not categorized\",\n        \"custom_fields\": {},\n        \"created_at\": 1569329082419\n      },\n      \"activity\": {\n        \"created_at\": 1569340658833,\n        \"email_body\": \"<!doctype html>\\n<html>\\n <head> \\n </head> \\n <body>\\n   Hi John\\n  <br>\\n  <br>Did you see my previous email?&nbsp;\\n  <br>\\n  <br>Regards,\\n  <br>Jes</body>\\n</html>\",\n        \"email_text_body\": \"Hi John, Did you see my previous email?, Regards, Jes\",\n        \"email_subject\": \"Following up\",\n        \"email_from\": \"jes@example.com\",\n        \"email_to\": \"john@company.com\",\n        \"campaign_name\": \"Sales Outreach: Jan\",\n        \"campaign_step_name\": \"Day 1: Opening\",\n        \"clicked_url\": null\n      }\n    }\n  ]\n}\n
\n","event":[{"listen":"prerequest","script":{"id":"b4028a79-f5c6-4116-a7e1-bc285aafc9c3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7c1204eb-344a-47b8-a68e-efa2cd880f49","type":"text/javascript","exec":[""]}}],"_postman_id":"e5642680-3b05-44f5-9767-ea7bf159d3c5"}],"event":[{"listen":"prerequest","script":{"id":"74b4a076-325e-40af-9470-6a0b4ce08f36","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"573e9232-e47e-4f1e-b2b5-69bfa5d2baf3","type":"text/javascript","exec":[""]}}]}