How to use Webhooks?

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": "e9168fc8-ab8a-4fc4-bc0b-22424faad142@outlook.com",
            "fromEmail": "hey@salesforge.ai",
            "fromName": "Frank Sondors",
            "toEmail": "bill@gates.com",
            "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": "bill@gates.com",
            "company": "Microsoft"
        },
        "sequence": {
            "id": "seq_verfvuynadkes5l1l0gdw",
            "name": "Salesforge Sequence"
        },
        "mailbox": {
            "id": "mbox_07ohxomu88jj7c85gjo8g",
            "firstName": "Frank",
            "lastName": "Sondors",
            "email": "hey@salesforge.ai",
            "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": "e9168fc8-ab8a-4fc4-bc0b-22424faad142@outlook.com",
            "fromEmail": "hey@salesforge.ai",
            "fromName": "Frank Sondors",
            "toEmail": "bill@gates.com",
            "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": "bill@gates.com",
            "company": "Microsoft"
        },
        "sequence": {
            "id": "seq_verfvuynadkes5l1l0gdw",
            "name": "Salesforge Sequence"
        },
        "mailbox": {
            "id": "mbox_07ohxomu88jj7c85gjo8g",
            "firstName": "Frank",
            "lastName": "Sondors",
            "email": "hey@salesforge.ai",
            "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": "e9168fc8-ab8a-4fc4-bc0b-22424faad142@outlook.com",
            "fromEmail": "hey@salesforge.ai",
            "fromName": "Frank Sondors",
            "toEmail": "bill@gates.com",
            "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": "bill@gates.com",
            "company": "Microsoft"
        },
        "sequence": {
            "id": "seq_verfvuynadkes5l1l0gdw",
            "name": "Salesforge Sequence"
        },
        "mailbox": {
            "id": "mbox_07ohxomu88jj7c85gjo8g",
            "firstName": "Frank",
            "lastName": "Sondors",
            "email": "hey@salesforge.ai",
            "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": "e9168fc8-ab8a-4fc4-bc0b-22424faad142@outlook.com",
            "fromEmail": "hey@salesforge.ai",
            "fromName": "Frank Sondors",
            "toEmail": "bill@gates.com",
            "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": "bill@gates.com",
            "company": "Microsoft"
        },
        "sequence": {
            "id": "seq_verfvuynadkes5l1l0gdw",
            "name": "Salesforge Sequence"
        },
        "mailbox": {
            "id": "mbox_07ohxomu88jj7c85gjo8g",
            "firstName": "Frank",
            "lastName": "Sondors",
            "email": "hey@salesforge.ai",
            "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": "e9168fc8-ab8a-4fc4-bc0b-22424faad142@outlook.com",
            "fromEmail": "hey@salesforge.ai",
            "fromName": "Frank Sondors",
            "toEmail": "bill@gates.com",
            "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": "bill@gates.com",
            "company": "Microsoft"
        },
        "sequence": {
            "id": "seq_verfvuynadkes5l1l0gdw",
            "name": "Salesforge Sequence"
        },
        "mailbox": {
            "id": "mbox_07ohxomu88jj7c85gjo8g",
            "firstName": "Frank",
            "lastName": "Sondors",
            "email": "hey@salesforge.ai",
            "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": "e9168fc8-ab8a-4fc4-bc0b-22424faad142@outlook.com",
            "fromEmail": "hey@salesforge.ai",
            "fromName": "Frank Sondors",
            "toEmail": "bill@gates.com",
            "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": "bill@gates.com",
            "company": "Microsoft"
        },
        "sequence": {
            "id": "seq_verfvuynadkes5l1l0gdw",
            "name": "Salesforge Sequence"
        },
        "mailbox": {
            "id": "mbox_07ohxomu88jj7c85gjo8g",
            "firstName": "Frank",
            "lastName": "Sondors",
            "email": "hey@salesforge.ai",
            "customDomain": "sf.salesforge.ai"
        },
        "replyEmail": {
            "emailId": "e9168fc8-ab8a-4fc4-bc0b-22424faad142@outlook.com",
            "fromEmail": "bill@gates.com",
            "fromName": "Bill Gates",
            "toEmail": "f@salesforge.ai",
            "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>"
            }
        }
    }


positive_reply

{
  "webhookInfo": {
    "id": "wh_or388zo2xuqf02k7sigl1",
    "eventTime": "2024-02-25T09:43:55+02:00",
    "type": "positive_reply"
  },
  "replyEmail": {
    "emailId": "e9168fc8-ab8a-4fc4-bc0b-22424faad142@outlook.com",
    "fromEmail": "bill@gates.com",
    "fromName": "Bill Gates",
    "toEmail": "f@salesforge.ai",
    "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>"
    }
  },
  "mailbox": {
    "id": "mbox_07ohxomu88jj7c85gjo8g",
    "firstName": "Frank",
    "lastName": "Sondors",
    "email": "hey@salesforge.ai",
    "customDomain": "sf.salesforge.ai"
  },
  "contact": {
    "id": "lead_mmxtxqo4920f4ohkwgid4",
    "firstName": "Bill",
    "lastName": "Gates",
    "email": "bill@gates.com",
    "company": "Microsoft"
  },
  "workspace": {
    "id": "wks_b1fln2njl9xtoh1miu7zx",
    "name": "Salesforge",
    "slug": "salesforge"
  }
}

negative_reply

{
  "webhookInfo": {
    "id": "wh_or388zo2xuqf02k7sigl1",
    "eventTime": "2024-02-25T09:43:55+02:00",
    "type": "negative_reply"
  },
  "replyEmail": {
    "emailId": "e9168fc8-ab8a-4fc4-bc0b-22424faad142@outlook.com",
    "fromEmail": "bill@gates.com",
    "fromName": "Bill Gates",
    "toEmail": "f@salesforge.ai",
    "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>"
    }
  },
  "mailbox": {
    "id": "mbox_07ohxomu88jj7c85gjo8g",
    "firstName": "Frank",
    "lastName": "Sondors",
    "email": "hey@salesforge.ai",
    "customDomain": "sf.salesforge.ai"
  },
  "contact": {
    "id": "lead_mmxtxqo4920f4ohkwgid4",
    "firstName": "Bill",
    "lastName": "Gates",
    "email": "bill@gates.com",
    "company": "Microsoft"
  },
  "workspace": {
    "id": "wks_b1fln2njl9xtoh1miu7zx",
    "name": "Salesforge",
    "slug": "salesforge"
  }
}
Did this answer your question?
😞
😐
😁