Webhooks
Daniel Castellanos avatar
Written by Daniel Castellanos
Updated over a week ago

In order to setup webhooks create a new webhook in Integration tab in Settings, choose URL and webhook type that you would like to receive. If no sequence id is selected, webhooks from all workspace will be trigerred.
โ€‹

Here are the payload for all webhook types.

email_sent

 {
"webhookInfo": {
"id": "wh_or388zo2xuqf02k7sigl1",
"eventTime": "2023-12-06T16:03:31+02:00",
"type": "email_sent"
},
"sequenceEmail": {
"emailId": "[email protected]",
"fromEmail": "[email protected]",
"fromName": "Frank Sondors",
"toEmail": "[email protected]",
"toName": "Bill Gates",
"subject": "More sales in Q4?",
"content": {
"text": "Hi Bill, I hope you're doing well. I wanted to reach out to you to see if you're interested in selling more computers.",
"html": "<p>Hi Bill, I hope you're doing well. I wanted to reach out to you to see if you're interested in selling more computers.<p>"
}
},
"workspace": {
"id": "wks_b1fln2njl9xtoh1miu7zx",
"name": "Salesforge",
"slug": "salesforge"
},
"contact": {
"id": "lead_mmxtxqo4920f4ohkwgid4",
"firstName": "Bill",
"lastName": "Gates",
"email": "[email protected]",
"company": "Microsoft"
},
"sequence": {
"id": "seq_verfvuynadkes5l1l0gdw",
"name": "Salesforge Sequence"
},
"mailbox": {
"id": "mbox_07ohxomu88jj7c85gjo8g",
"firstName": "Frank",
"lastName": "Sondors",
"email": "[email protected]",
"customDomain": "sf.salesforge.ai"
},
"emailSentData": {
"step": 1,
"ai_generated": false
}
}

email_opened


{
"webhookInfo": {
"id": "wh_or388zo2xuqf02k7sigl1",
"eventTime": "2023-12-06T16:00:38+02:00",
"type": "email_opened"
},
"sequenceEmail": {
"emailId": "[email protected]",
"fromEmail": "[email protected]",
"fromName": "Frank Sondors",
"toEmail": "[email protected]",
"toName": "Bill Gates",
"subject": "More sales in Q4?",
"content": {
"text": "Hi Bill, I hope you're doing well. I wanted to reach out to you to see if you're interested in selling more computers.",
"html": "<p>Hi Bill, I hope you're doing well. I wanted to reach out to you to see if you're interested in selling more computers.<p>"
}
},
"workspace": {
"id": "wks_b1fln2njl9xtoh1miu7zx",
"name": "Salesforge",
"slug": "salesforge"
},
"contact": {
"id": "lead_mmxtxqo4920f4ohkwgid4",
"firstName": "Bill",
"lastName": "Gates",
"email": "[email protected]",
"company": "Microsoft"
},
"sequence": {
"id": "seq_verfvuynadkes5l1l0gdw",
"name": "Salesforge Sequence"
},
"mailbox": {
"id": "mbox_07ohxomu88jj7c85gjo8g",
"firstName": "Frank",
"lastName": "Sondors",
"email": "[email protected]",
"customDomain": "sf.salesforge.ai"
},
"emailOpenedData": {
"openedAt": "2023-12-06T16:00:38+02:00"
}
}

link_clicked

{
"webhookInfo": {
"id": "wh_or388zo2xuqf02k7sigl1",
"eventTime": "2023-12-06T16:04:22+02:00",
"type": "email_bounced"
},
"sequenceEmail": {
"emailId": "[email protected]",
"fromEmail": "[email protected]",
"fromName": "Frank Sondors",
"toEmail": "[email protected]",
"toName": "Bill Gates",
"subject": "More sales in Q4?",
"content": {
"text": "Hi Bill, I hope you're doing well. I wanted to reach out to you to see if you're interested in selling more computers.",
"html": "<p>Hi Bill, I hope you're doing well. I wanted to reach out to you to see if you're interested in selling more computers.<p>"
}
},
"link": "",
"workspace": {
"id": "wks_b1fln2njl9xtoh1miu7zx",
"name": "Salesforge",
"slug": "salesforge"
},
"contact": {
"id": "lead_mmxtxqo4920f4ohkwgid4",
"firstName": "Bill",
"lastName": "Gates",
"email": "[email protected]",
"company": "Microsoft"
},
"sequence": {
"id": "seq_verfvuynadkes5l1l0gdw",
"name": "Salesforge Sequence"
},
"mailbox": {
"id": "mbox_07ohxomu88jj7c85gjo8g",
"firstName": "Frank",
"lastName": "Sondors",
"email": "[email protected]",
"customDomain": "sf.salesforge.ai"
},
"linkClickedData": {
"clickedAt": "2023-12-06T16:04:22+02:00"
}
}

contact_unsubscribed


{
"webhookInfo": {
"id": "wh_or388zo2xuqf02k7sigl1",
"eventTime": "2023-12-06T16:06:47+02:00",
"type": "email_bounced"
},
"sequenceEmail": {
"emailId": "[email protected]",
"fromEmail": "[email protected]",
"fromName": "Frank Sondors",
"toEmail": "[email protected]",
"toName": "Bill Gates",
"subject": "More sales in Q4?",
"content": {
"text": "Hi Bill, I hope you're doing well. I wanted to reach out to you to see if you're interested in selling more computers.",
"html": "<p>Hi Bill, I hope you're doing well. I wanted to reach out to you to see if you're interested in selling more computers.<p>"
}
},
"workspace": {
"id": "wks_b1fln2njl9xtoh1miu7zx",
"name": "Salesforge",
"slug": "salesforge"
},
"contact": {
"id": "lead_mmxtxqo4920f4ohkwgid4",
"firstName": "Bill",
"lastName": "Gates",
"email": "[email protected]",
"company": "Microsoft"
},
"sequence": {
"id": "seq_verfvuynadkes5l1l0gdw",
"name": "Salesforge Sequence"
},
"mailbox": {
"id": "mbox_07ohxomu88jj7c85gjo8g",
"firstName": "Frank",
"lastName": "Sondors",
"email": "[email protected]",
"customDomain": "sf.salesforge.ai"
},
"contactUnsubscribedData": {
"unsubscribedAt": "2023-12-06T16:06:47+02:00"
}
}

email_bounced

{
"webhookInfo": {
"id": "wh_or388zo2xuqf02k7sigl1",
"eventTime": "2023-12-06T16:09:12+02:00",
"type": "email_bounced"
},
"sequenceEmail": {
"emailId": "[email protected]",
"fromEmail": "[email protected]",
"fromName": "Frank Sondors",
"toEmail": "[email protected]",
"toName": "Bill Gates",
"subject": "More sales in Q4?",
"content": {
"text": "Hi Bill, I hope you're doing well. I wanted to reach out to you to see if you're interested in selling more computers.",
"html": "<p>Hi Bill, I hope you're doing well. I wanted to reach out to you to see if you're interested in selling more computers.<p>"
}
},
"workspace": {
"id": "wks_b1fln2njl9xtoh1miu7zx",
"name": "Salesforge",
"slug": "salesforge"
},
"contact": {
"id": "lead_mmxtxqo4920f4ohkwgid4",
"firstName": "Bill",
"lastName": "Gates",
"email": "[email protected]",
"company": "Microsoft"
},
"sequence": {
"id": "seq_verfvuynadkes5l1l0gdw",
"name": "Salesforge Sequence"
},
"mailbox": {
"id": "mbox_07ohxomu88jj7c85gjo8g",
"firstName": "Frank",
"lastName": "Sondors",
"email": "[email protected]",
"customDomain": "sf.salesforge.ai"
},
"emailBounced": {
"bouncedAt": "2023-12-06T16:09:12+02:00"
}
}

email_replied


{
"webhookInfo": {
"id": "wh_or388zo2xuqf02k7sigl1",
"eventTime": "2023-12-06T16:18:22+02:00",
"type": "email_replied"
},
"sequenceEmail": {
"emailId": "[email protected]",
"fromEmail": "[email protected]",
"fromName": "Frank Sondors",
"toEmail": "[email protected]",
"toName": "Bill Gates",
"subject": "More sales in Q4?",
"content": {
"text": "Hi Bill, I hope you're doing well. I wanted to reach out to you to see if you're interested in selling more computers.",
"html": "<p>Hi Bill, I hope you're doing well. I wanted to reach out to you to see if you're interested in selling more computers.<p>"
}
},
"workspace": {
"id": "wks_b1fln2njl9xtoh1miu7zx",
"name": "Salesforge",
"slug": "salesforge"
},
"contact": {
"id": "lead_mmxtxqo4920f4ohkwgid4",
"firstName": "Bill",
"lastName": "Gates",
"email": "[email protected]",
"company": "Microsoft"
},
"sequence": {
"id": "seq_verfvuynadkes5l1l0gdw",
"name": "Salesforge Sequence"
},
"mailbox": {
"id": "mbox_07ohxomu88jj7c85gjo8g",
"firstName": "Frank",
"lastName": "Sondors",
"email": "[email protected]",
"customDomain": "sf.salesforge.ai"
},
"replyEmail": {
"emailId": "[email protected]",
"fromEmail": "[email protected]",
"fromName": "Bill Gates",
"toEmail": "[email protected]",
"toName": "Frank Sondors",
"subject": "Re: More sales in Q4?",
"content": {
"text": "Hi Frank, I'm interested in selling more computers. Can you send me more information?",
"html": "<p>Hi Frank, I'm interested in selling more computers. Can you send me more information?<p>"
}
}
}
Did this answer your question?