A workspace holds at most 200 webhooks, and a targetUrl can only be registered once. Both limits answer 409, with a JSON body whose error field tells them apart:
error
Cause
What to do
Too many webhooks (max 200 per team, disabled webhooks included)
The workspace is at the cap.
Free a slot with Delete Webhook. Disabled webhooks count too — see below.
A webhook with this targetUrl already exists
Another webhook already points to that URL.
Reuse it, or register a distinct URL.
Uniqueness is on targetUrl alone, regardless of type and campaignId. The
same URL cannot be registered twice to subscribe to two event types — either
register it once without a type (it then receives every event, and you filter
on your side), or give each subscription its own URL.
When a delivery fails in a way that says the destination is gone — your endpoint answers 404 or 410, or its host does not resolve — lemlist disables the webhook instead of deleting it, and notifies its owner. Get Many Webhooks keeps returning it, carrying disabled: true, disabledReason: "deliveryError", disabledAt and lastErrorStatus.A disabled webhook stops firing but keeps its slot, and nothing purges it. A workspace showing a handful of live webhooks can therefore be refused a new one. When you check the remaining room, count every entry GET /hooks returns, not just the active ones, and delete those you no longer need.
Contact unsubscribed from all communications — e.g. clicked the unsubscribe link or was marked as do-not-contact
variableUnsubscribed
A specific contact variable (email address, phone number, LinkedIn profile) was unsubscribed
emailsUnsubscribed
Lead stopped because their email or domain is on the unsubscribe list. Also matches apiUnsubscribed and manualUnsubscribed activities
Since March 30, 2026, a contact unsubscribing emits entityUnsubscribed (whole
contact) or variableUnsubscribed (single variable) instead of
emailsUnsubscribed. If your integration listens to emailsUnsubscribed,
also subscribe to entityUnsubscribed and variableUnsubscribed to keep
receiving unsubscribe events.
Enrichment completed; requested workflows that ended without any result are listed in failedWorkflows
enrichmentError
Enrichment failed as a whole; the payload carries a code and a reason
Enrichment events do not mirror an activity: their body is {"type": "<event>", "data": [...]}, one item per enrichment. See Enrichment webhooks for the payload.
Subscribe to contactSourcingFailed as well as contactSourcingDone: a run
that fails never emits the done event, so an integration listening only for
the latter waits for a result that is not coming.
Current contact record (its fields, custom fields and company), added at delivery time to every event that has a contactId. Never overrides a key already set on the event
sendUserId, sendUserEmail, sendUserName
string
Sender (lemlist user) identity
subject
string
Email subject (email events only)
secret
string
Echoed back if a secret was set on the webhook
Non-campaign events carry no lead* keys. An activity created from a
contact page or the inbox rather than from a campaign step (a LinkedIn message
sent outside a campaign, its opens and replies) has a
contactId but no leadId, so leadFirstName, leadLastName and leadEmail
are absent: there is no lead to take them from. firstName, lastName and
email are still present, read from the contact. To get a name on every
event, read firstName / lastName, or leadFirstName / leadLastName with
a fallback to them.
stepId identifies the step itself, while sequenceStep is a position that
shifts when a sequence’s steps are reordered — prefer stepId when you store a
reference. Both are sent: sequenceStep is unchanged. stepId is present on
every activity created from now on, and older activities gain it progressively
as historical records are backfilled.
Email events (emailsSent, emailsReplied, emailsBounced) carry the full recipient lists as arrays of {address, name}. Addresses are lowercased. Fields are omitted when empty.
to — primary recipient(s). For outbound sends, this is the lead. For inbound replies, this is the mailbox owner; multi-recipient to lines (e.g. reply-all where the lead manually added people) are preserved.
cc — explicit CC recipients on the email.
bcc — only present for outbound emailsSent events when the sender has a hidden BCC configured in Settings → Integrations (users.lemlist.bcc). Inbound BCC is never visible because SMTP strips it for non-BCC’d recipients.
When a reply on a thread comes from an address that does not match the original lead’s known contact emails, lemlist attributes the reply to the third-party sender rather than to the lead, and the event carries an extra flag:
Third-party reply payloads omit campaignId, leadId, and sequenceId (since the reply is no longer attached to the original campaign flow). Use the flag to route these events differently if needed.
Optional shared secret. Stored encrypted, never returned by GET, and immutable once set. Sent back to your endpoint as a secret field in the body of every webhook call so you can verify the request originated from lemlist.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"lemlist Developer Docs","description":"lemlist API documentation to help you integrate and automate your email outreach.","colors":{"primary":"#316bff","light":"#316bff","dark":"#316bff"},"logo":{"light":"https://mintcdn.com/lemlist/2iZ5pwNAqbuSITlr/logo/light.svg?fit=max\u0026auto=format\u0026n=2iZ5pwNAqbuSITlr\u0026q=85\u0026s=788986080ad8b8885e095b71df22a88c","dark":"https://mintcdn.com/lemlist/2iZ5pwNAqbuSITlr/logo/dark.svg?fit=max\u0026auto=format\u0026n=2iZ5pwNAqbuSITlr\u0026q=85\u0026s=e35c628bd52e1f84bda9094bf3daffab"},"favicon":{"light":"https://mintcdn.com/lemlist/h9afJCVUSdV-WX4K/favicon.ico?fit=max\u0026auto=format\u0026n=h9afJCVUSdV-WX4K\u0026q=85\u0026s=1d6a5fac00a4a5a670d3d8c0bbc7593d","dark":"https://mintcdn.com/lemlist/h9afJCVUSdV-WX4K/favicon.ico?fit=max\u0026auto=format\u0026n=h9afJCVUSdV-WX4K\u0026q=85\u0026s=1d6a5fac00a4a5a670d3d8c0bbc7593d"},"api":{"params":{"expanded":"closed"},"playground":{"display":"interactive","proxy":true},"examples":{"defaults":"required","languages":["curl","python","javascript","ruby","php"],"prefill":true},"mdx":{"auth":{"method":"basic","name":"Basic"}}},"appearance":{"default":"system"},"navbar":{"links":[{"href":"https://lemlist.typeform.com/to/mfVlkyGf","label":"Send your feedback"}],"primary":{"type":"button","label":"Open App","href":"https://app.lemlist.com"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/lemlist","youtube":"https://www.youtube.com/c/lemlist"}},"search":{"prompt":"Search..."},"seo":{"metatags":{"robots":"index","charset":"UTF-8","viewport":"width=device-width, initial-scale=1.0","description":"lemlist API helps you to automate your outreach, build powerful workflows, subscribe to alerts, enrich your database and much more. It is easy to integrate, try it out!","keywords":"outbound, outreach, sales, automation","googlebot":"index, follow","google-site-verification":"verification_token","generator":"Mintlify","theme-color":"#000000","color-scheme":"light dark","format-detection":"telephone=no","referrer":"origin","refresh":"30","rating":"general","revisit-after":"7 days","language":"en","og:title":"Lemlist Developer Docs","og:type":"website","og:url":"https://developer.lemlist.com","og:image":"https://developer.lemlist.com/thumbnails/dark.jpeg","og:description":"lemlist API helps you to automate your outreach, build powerful workflows, subscribe to alerts, enrich your database and much more. It is easy to integrate, try it out!","og:site_name":"lemlist Developer Docs","og:locale":"en_US"},"indexing":"all"},"fonts":{"heading":{"family":"Inter","weight":700},"body":{"family":"Inter","weight":500}},"icons":{"library":"fontawesome"},"styling":{"eyebrows":"section","codeblocks":{"theme":"dracula"},"latex":false},"integrations":{"ga4":{"measurementId":"G-XRXQRF7W03"},"gtm":{"tagId":"GTM-PRZ945S"}},"errors":{"404":{"redirect":false,"title":"someone took the wrong turn 🌝","description":""}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"thumbnails":{"appearance":"dark","background":"https://mintcdn.com/lemlist/A9DixBwcDG7hidJ9/thumbnails/dark.jpeg?fit=max\u0026auto=format\u0026n=A9DixBwcDG7hidJ9\u0026q=85\u0026s=28c3824c256d42c704eb5a45b60ad8e5"},"interaction":{"drilldown":true},"navigation":{"global":{"versions":[{"version":"v2","default":false,"hidden":false,"href":"https://developer.lemlist.com/"}],"anchors":[{"anchor":"Start lemlist free trial","icon":"play","href":"https://app.lemlist.com/create-account"},{"anchor":"Talk to a human","icon":"headphones","href":"https://www.lemlist.com/contact-sales?r=0"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lemlist","hasAudioNarration":false,"actualSubdomain":"lemlist","customDomains":["developer.lemlist.com"],"gitSource":{"type":"github","owner":"l3mpire","repo":"mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af1e8a32e1c4ffcdc0c3de0","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":280},{"language":"default","tag":"Endpoints","count":232},{"language":"default","tag":"Objects \u0026 Definitions","count":44},{"language":"default","tag":"Campaigns","count":25},{"language":"default","tag":"Leads","count":22},{"language":"default","tag":"Contacts","count":17},{"language":"default","tag":"Sequences","count":17},{"language":"default","tag":"Inbox","count":16},{"language":"default","tag":"People database","count":14},{"language":"default","tag":"Signal Agents","count":13}]},"assistantConfig":{"enableStarterQuestions":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"6920211ae3c0df65ab8a60e2","deploymentId":"68e934a81f764bc8b225533c","questionText":"How do I automatically add leads to campaign with auto launch?","status":"active","generatedBy":"manual","createdAt":"2025-11-21T08:21:46.035Z","updatedAt":"2025-11-21T08:22:06.570Z","__v":0}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoints/webhooks/add-webhook","slug":"/api-reference/endpoints/webhooks/add-webhook","pageMetadata":{"openapi":"post /hooks","description":"Creates a webhook that receives real-time POST callbacks for selected events.","title":"Add Webhook","href":"/api-reference/endpoints/webhooks/add-webhook"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Creates a webhook that receives real-time POST callbacks for selected events.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const SnippetObjectReference=({objectName,objectPath=null})=>{const _components={a:`a`,..._provideComponents()},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);const lowerCaseObjectName=objectName.toLowerCase();if(lowerCaseObjectName===`lead`||lowerCaseObjectName===`leads`){return _jsxs(Note,{children:[`This endpoint uses the `,_jsxs(_components.a,{href:`/api-reference/objects-definitions/${objectPath}`,children:[objectName,` object`]}),`. Make sure to also check the `,_jsxs(_components.a,{href:`/api-reference/objects-definitions/${lowerCaseObjectName===`lead`?`contact`:`lead`}`,children:[lowerCaseObjectName===`lead`?`Contact`:`Lead`,` object`]}),` to understand the distinction between the two.`]})}return _jsxs(Note,{children:[`This endpoint uses the `,_jsxs(_components.a,{href:`/api-reference/objects-definitions/${objectPath}`,children:[objectName,` object`]}),`.`]})};function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Heading,Note,Table,Warning,_MdxComponentBoundary}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsxs(_Fragment,{children:[_jsx(_MdxComponentBoundary,{name:`SnippetObjectReference`,children:_jsx(SnippetObjectReference,{objectName:`Webhook`,objectPath:`webhook`})}),`\n`,_jsxs(_components.p,{children:[`The API key’s user must have the “Edit integrations” permission, otherwise the request fails with `,_jsx(_components.code,{children:`403`}),` and no webhook is created.`]}),`\n`,_jsx(Heading,{level:`2`,id:`limits-and-conflicts`,children:`Limits and conflicts`}),`\n`,_jsxs(_components.p,{children:[`A workspace holds at most `,_jsx(_components.strong,{children:`200 webhooks`}),`, and a `,_jsx(_components.code,{children:`targetUrl`}),` can only be registered once. Both limits answer `,_jsx(_components.code,{children:`409`}),`, with a JSON body whose `,_jsx(_components.code,{children:`error`}),` field tells them apart:`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:_jsx(_components.code,{children:`error`})}),_jsx(_components.th,{children:`Cause`}),_jsx(_components.th,{children:`What to do`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`Too many webhooks (max 200 per team, disabled webhooks included)`})}),_jsx(_components.td,{children:`The workspace is at the cap.`}),_jsxs(_components.td,{children:[`Free a slot with `,_jsx(_components.a,{href:`/api-reference/endpoints/webhooks/delete-webhook`,children:`Delete Webhook`}),`. Disabled webhooks count too — see below.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`A webhook with this targetUrl already exists`})}),_jsx(_components.td,{children:`Another webhook already points to that URL.`}),_jsx(_components.td,{children:`Reuse it, or register a distinct URL.`})]})]})]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Uniqueness is on `,_jsx(_components.code,{children:`targetUrl`}),` alone, regardless of `,_jsx(_components.code,{children:`type`}),` and `,_jsx(_components.code,{children:`campaignId`}),`. The\nsame URL cannot be registered twice to subscribe to two event types — either\nregister it once without a `,_jsx(_components.code,{children:`type`}),` (it then receives every event, and you filter\non your side), or give each subscription its own URL.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`disabled-webhooks-still-count-toward-the-cap`,children:`Disabled webhooks still count toward the cap`}),`\n`,_jsxs(_components.p,{children:[`When a delivery fails in a way that says the destination is gone — your endpoint answers `,_jsx(_components.code,{children:`404`}),` or `,_jsx(_components.code,{children:`410`}),`, or its host does not resolve — lemlist disables the webhook instead of deleting it, and notifies its owner. `,_jsx(_components.a,{href:`/api-reference/endpoints/webhooks/get-many-webhooks`,children:`Get Many Webhooks`}),` keeps returning it, carrying `,_jsx(_components.code,{children:`disabled: true`}),`, `,_jsx(_components.code,{children:`disabledReason: \"deliveryError\"`}),`, `,_jsx(_components.code,{children:`disabledAt`}),` and `,_jsx(_components.code,{children:`lastErrorStatus`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`A disabled webhook stops firing but keeps its slot, and nothing purges it. A workspace showing a handful of live webhooks can therefore be refused a new one. When you check the remaining room, count `,_jsx(_components.strong,{children:`every`}),` entry `,_jsx(_components.code,{children:`GET /hooks`}),` returns, not just the active ones, and delete those you no longer need.`]}),`\n`,_jsx(Heading,{level:`2`,id:`available-event-types`,children:`Available event types`}),`\n`,_jsxs(_components.p,{children:[`When creating a webhook, you can subscribe to specific events using the `,_jsx(_components.code,{children:`type`}),` field. Events are organized by category below.`]}),`\n`,_jsx(Heading,{level:`3`,id:`lead-state-groups`,children:`Lead state groups`}),`\n`,_jsx(_components.p,{children:`These aggregate multiple activity types into a single lead-state change event.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Event`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`contacted`})}),_jsx(_components.td,{children:`Lead was contacted (email sent, LinkedIn message, API call, etc.)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hooked`})}),_jsx(_components.td,{children:`Lead opened a message (email, LinkedIn, WhatsApp)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`attracted`})}),_jsx(_components.td,{children:`Lead clicked a link or accepted a LinkedIn invite`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`warmed`})}),_jsx(_components.td,{children:`Lead replied (email, LinkedIn, WhatsApp, SMS)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`interested`})}),_jsx(_components.td,{children:`Lead marked as interested`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`notInterested`})}),_jsx(_components.td,{children:`Lead marked as not interested`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`email-activities`,children:`Email activities`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Event`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`emailsSent`})}),_jsx(_components.td,{children:`Email sent`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`emailsOpened`})}),_jsx(_components.td,{children:`Email opened`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`emailsClicked`})}),_jsx(_components.td,{children:`Link clicked in email`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`emailsReplied`})}),_jsx(_components.td,{children:`Email replied`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`emailsBounced`})}),_jsx(_components.td,{children:`Email bounced`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`emailsFailed`})}),_jsx(_components.td,{children:`Email failed to send`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`emailsInterested`})}),_jsx(_components.td,{children:`Lead marked as interested via email`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`emailsNotInterested`})}),_jsx(_components.td,{children:`Lead marked as not interested via email`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`unsubscribe-activities`,children:`Unsubscribe activities`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Event`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`entityUnsubscribed`})}),_jsx(_components.td,{children:`Contact unsubscribed from all communications — e.g. clicked the unsubscribe link or was marked as do-not-contact`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`variableUnsubscribed`})}),_jsx(_components.td,{children:`A specific contact variable (email address, phone number, LinkedIn profile) was unsubscribed`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`emailsUnsubscribed`})}),_jsxs(_components.td,{children:[`Lead stopped because their email or domain is on the unsubscribe list. Also matches `,_jsx(_components.code,{children:`apiUnsubscribed`}),` and `,_jsx(_components.code,{children:`manualUnsubscribed`}),` activities`]})]})]})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Since March 30, 2026, a contact unsubscribing emits `,_jsx(_components.code,{children:`entityUnsubscribed`}),` (whole\ncontact) or `,_jsx(_components.code,{children:`variableUnsubscribed`}),` (single variable) instead of\n`,_jsx(_components.code,{children:`emailsUnsubscribed`}),`. If your integration listens to `,_jsx(_components.code,{children:`emailsUnsubscribed`}),`,\nalso subscribe to `,_jsx(_components.code,{children:`entityUnsubscribed`}),` and `,_jsx(_components.code,{children:`variableUnsubscribed`}),` to keep\nreceiving unsubscribe events.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`linkedin-activities`,children:`LinkedIn activities`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Event`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinSent`})}),_jsx(_components.td,{children:`LinkedIn message sent`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinOpened`})}),_jsx(_components.td,{children:`LinkedIn message opened`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinReplied`})}),_jsx(_components.td,{children:`LinkedIn message replied`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinInterested`})}),_jsx(_components.td,{children:`Lead marked as interested via LinkedIn`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinNotInterested`})}),_jsx(_components.td,{children:`Lead marked as not interested via LinkedIn`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinSendFailed`})}),_jsx(_components.td,{children:`LinkedIn message failed to send`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinVisitDone`})}),_jsx(_components.td,{children:`LinkedIn profile visit completed`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinVisitFailed`})}),_jsx(_components.td,{children:`LinkedIn profile visit failed`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinFollowDone`})}),_jsx(_components.td,{children:`LinkedIn follow completed`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinFollowFailed`})}),_jsx(_components.td,{children:`LinkedIn follow failed`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinFollowSkipped`})}),_jsx(_components.td,{children:`LinkedIn follow skipped`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinInviteDone`})}),_jsx(_components.td,{children:`LinkedIn invite sent`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinInviteFailed`})}),_jsx(_components.td,{children:`LinkedIn invite failed`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinInviteAccepted`})}),_jsx(_components.td,{children:`LinkedIn invite accepted`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinEndorseDone`})}),_jsx(_components.td,{children:`LinkedIn endorsement completed`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinEndorseFailed`})}),_jsx(_components.td,{children:`LinkedIn endorsement failed`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinEndorseSkipped`})}),_jsx(_components.td,{children:`LinkedIn endorsement skipped`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinVoiceNoteDone`})}),_jsx(_components.td,{children:`LinkedIn voice note sent`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinVoiceNoteFailed`})}),_jsx(_components.td,{children:`LinkedIn voice note failed`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinLikeLastPostDone`})}),_jsx(_components.td,{children:`LinkedIn like last post completed`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinLikeLastPostNoPost`})}),_jsx(_components.td,{children:`LinkedIn like last post — no post found`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinLikeLastPostFailed`})}),_jsx(_components.td,{children:`LinkedIn like last post failed`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinWithdrawInvitationDone`})}),_jsx(_components.td,{children:`LinkedIn invite withdrawn`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`linkedinWithdrawInvitationFailed`})}),_jsx(_components.td,{children:`LinkedIn invite withdrawal failed`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`whatsapp-activities`,children:`WhatsApp activities`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Event`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`whatsappMessageSent`})}),_jsx(_components.td,{children:`WhatsApp message sent`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`whatsappMessageDelivered`})}),_jsx(_components.td,{children:`WhatsApp message delivered`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`whatsappMessageOpened`})}),_jsx(_components.td,{children:`WhatsApp message opened`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`whatsappReplied`})}),_jsx(_components.td,{children:`WhatsApp message replied`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`whatsappMessageFailed`})}),_jsx(_components.td,{children:`WhatsApp message failed`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`sms-activities`,children:`SMS activities`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Event`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`smsSent`})}),_jsx(_components.td,{children:`SMS sent`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`smsDelivered`})}),_jsx(_components.td,{children:`SMS delivered`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`smsReplied`})}),_jsx(_components.td,{children:`SMS replied`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`smsFailed`})}),_jsx(_components.td,{children:`SMS failed`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`call-activities`,children:`Call activities`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Event`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`aircallCreated`})}),_jsx(_components.td,{children:`Call created`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`aircallEnded`})}),_jsx(_components.td,{children:`Call ended`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`aircallDone`})}),_jsx(_components.td,{children:`Call task completed`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`aircallInterested`})}),_jsx(_components.td,{children:`Lead marked as interested via call`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`aircallNotInterested`})}),_jsx(_components.td,{children:`Lead marked as not interested via call`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`callRecordingDone`})}),_jsx(_components.td,{children:`Call recording ready`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`callTranscriptDone`})}),_jsx(_components.td,{children:`Call transcript ready`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`api-activities`,children:`API activities`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Event`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`apiDone`})}),_jsx(_components.td,{children:`API step executed`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`apiInterested`})}),_jsx(_components.td,{children:`Lead marked as interested via API`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`apiNotInterested`})}),_jsx(_components.td,{children:`Lead marked as not interested via API`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`apiFailed`})}),_jsx(_components.td,{children:`API step failed`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`manual-activities`,children:`Manual activities`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Event`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`manualInterested`})}),_jsx(_components.td,{children:`Lead marked as interested manually`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`manualNotInterested`})}),_jsx(_components.td,{children:`Lead marked as not interested manually`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`task-activities`,children:`Task activities`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Event`}),_jsx(_components.th,{children:`Description`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`annotated`})}),_jsx(_components.td,{children:`Lead annotated`})]})})]}),`\n`,_jsx(Heading,{level:`3`,id:`workspace-activities`,children:`Workspace activities`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Event`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`paused`})}),_jsx(_components.td,{children:`Lead paused`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`resumed`})}),_jsx(_components.td,{children:`Lead resumed`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`stopped`})}),_jsx(_components.td,{children:`Lead stopped`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`campaignComplete`})}),_jsx(_components.td,{children:`Campaign completed`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`customDomainErrors`})}),_jsx(_components.td,{children:`Custom domain error detected`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`connectionIssue`})}),_jsx(_components.td,{children:`Email account connection issue`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`sendLimitReached`})}),_jsx(_components.td,{children:`Daily send limit reached`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`lemwarmPaused`})}),_jsx(_components.td,{children:`Lemwarm paused`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`enrichment`,children:`Enrichment`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Event`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`enrichmentDone`})}),_jsxs(_components.td,{children:[`Enrichment completed; requested workflows that ended without any result are listed in `,_jsx(_components.code,{children:`failedWorkflows`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`enrichmentError`})}),_jsxs(_components.td,{children:[`Enrichment failed as a whole; the payload carries a `,_jsx(_components.code,{children:`code`}),` and a `,_jsx(_components.code,{children:`reason`})]})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Enrichment events do not mirror an activity: their body is `,_jsx(_components.code,{children:`{\"type\": \"\u003cevent>\", \"data\": [...]}`}),`, one item per enrichment. See `,_jsx(_components.a,{href:`/api-reference/objects-definitions/enrich#webhooks`,children:`Enrichment webhooks`}),` for the payload.`]}),`\n`,_jsx(Heading,{level:`3`,id:`contact-sourcing`,children:`Contact sourcing`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Event`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`contactSourcingDone`})}),_jsx(_components.td,{children:`A contact-sourcing run finished; the payload carries the buying committee it found`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`contactSourcingFailed`})}),_jsx(_components.td,{children:`A contact-sourcing run failed; the payload carries the reason`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`The payload of both is the same shape `,_jsx(_components.a,{href:`/api-reference/endpoints/contact-sourcing/get-contact-sourcing-run`,children:`Get Contact Sourcing Run`}),` answers with, under a `,_jsx(_components.code,{children:`data`}),` key.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Subscribe to `,_jsx(_components.code,{children:`contactSourcingFailed`}),` as well as `,_jsx(_components.code,{children:`contactSourcingDone`}),`: a run\nthat fails never emits the done event, so an integration listening only for\nthe latter waits for a result that is not coming.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`inbox-activities`,children:`Inbox activities`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Event`}),_jsx(_components.th,{children:`Description`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`inboxLabelUpdated`})}),_jsx(_components.td,{children:`Inbox conversation label changed`})]})})]}),`\n`,_jsx(Heading,{level:`3`,id:`signal-agents`,children:`Signal Agents`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Event`}),_jsx(_components.th,{children:`Description`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`signalRegistered`})}),_jsx(_components.td,{children:`New signal detected by a Signal Agent`})]})})]}),`\n`,_jsx(Heading,{level:`3`,id:`deliverability-hub`,children:`Deliverability hub`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Event`}),_jsx(_components.th,{children:`Description`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`deliverabilityAlertTriggered`})}),_jsx(_components.td,{children:`Deliverability alert triggered`})]})})]}),`\n`,_jsx(Heading,{level:`3`,id:`deprecated-events`,children:`Deprecated events`}),`\n`,_jsx(_components.p,{children:`These events have been removed from the API. Use the replacements below.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Removed event`}),_jsx(_components.th,{children:`Replacement`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`skipped`})}),_jsx(_components.td,{children:`No direct replacement`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`emailsSendFailed`})}),_jsxs(_components.td,{children:[`Use `,_jsx(_components.code,{children:`emailsFailed`}),` instead`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`opportunitiesDone`})}),_jsxs(_components.td,{children:[`Use `,_jsx(_components.code,{children:`annotated`}),` or task-level webhooks instead`]})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`verifying-webhook-authenticity`,children:`Verifying webhook authenticity`}),`\n`,_jsxs(_components.p,{children:[`You can pass an optional `,_jsx(_components.code,{children:`secret`}),` in the request body when creating the webhook. It works like a shared password between lemlist and your endpoint:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Stored encrypted at rest.`}),`\n`,_jsxs(_components.li,{children:[`Never returned by `,_jsx(_components.code,{children:`GET /hooks`}),` or any other endpoint.`]}),`\n`,_jsx(_components.li,{children:`Immutable — it cannot be changed after creation. To rotate it, delete the webhook and create a new one.`}),`\n`,_jsxs(_components.li,{children:[`Sent back to your endpoint as a `,_jsx(_components.code,{children:`secret`}),` field in the JSON body of every webhook call, so you can verify the request originated from lemlist.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`webhook-payload`,children:`Webhook payload`}),`\n`,_jsxs(_components.p,{children:[`Each event is delivered as a `,_jsx(_components.code,{children:`POST`}),` to your `,_jsx(_components.code,{children:`targetUrl`}),` with a JSON body that mirrors the underlying activity record. Common fields:`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`_id`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Unique activity identifier (`,_jsx(_components.code,{children:`act_…`}),`)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`type`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Event type (e.g. `,_jsx(_components.code,{children:`emailsSent`}),`, `,_jsx(_components.code,{children:`emailsReplied`}),`)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`teamId`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Team the activity belongs to`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`createdAt`})}),_jsx(_components.td,{children:`ISO date`}),_jsx(_components.td,{children:`When the activity happened`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`campaignId`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Source campaign (absent for non-campaign events)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`campaignName`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Campaign display name`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`sequenceId`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Sequence the task belonged to`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`sequenceStep`})}),_jsx(_components.td,{children:`number`}),_jsx(_components.td,{children:`0-based step index in the sequence`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`stepId`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Stable identifier of the step (survives a reorder — see note below)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`journeyDepth`})}),_jsx(_components.td,{children:`number`}),_jsx(_components.td,{children:`0-based depth of the step on the lead’s own path: the step the lead reached before it, plus one. Absent on events recorded before it shipped`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`leadId`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Lead targeted by the activity (campaign events only)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`contactId`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Contact the activity relates to`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`leadEmail`}),`, `,_jsx(_components.code,{children:`leadFirstName`}),`, `,_jsx(_components.code,{children:`leadLastName`}),`, `,_jsx(_components.code,{children:`leadCompanyName`}),`, `,_jsx(_components.code,{children:`leadPhone`}),`, `,_jsx(_components.code,{children:`leadPicture`})]}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Lead identity as it was when the event happened. Campaign events only, and only the variables the lead had at that moment`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`email`}),`, `,_jsx(_components.code,{children:`firstName`}),`, `,_jsx(_components.code,{children:`lastName`}),`, `,_jsx(_components.code,{children:`linkedinUrl`}),`, `,_jsx(_components.code,{children:`phone`}),`, `,_jsx(_components.code,{children:`jobTitle`}),`, `,_jsx(_components.code,{children:`companyName`}),`, …`]}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Current contact record (its fields, custom fields and company), added at delivery time to every event that has a `,_jsx(_components.code,{children:`contactId`}),`. Never overrides a key already set on the event`]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`sendUserId`}),`, `,_jsx(_components.code,{children:`sendUserEmail`}),`, `,_jsx(_components.code,{children:`sendUserName`})]}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Sender (lemlist user) identity`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`subject`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Email subject (email events only)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`secret`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Echoed back if a `,_jsx(_components.code,{children:`secret`}),` was set on the webhook`]})]})]})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsxs(_components.strong,{children:[`Non-campaign events carry no `,_jsx(_components.code,{children:`lead*`}),` keys.`]}),` An activity created from a\ncontact page or the inbox rather than from a campaign step (a LinkedIn message\nsent outside a campaign, its opens and replies) has a\n`,_jsx(_components.code,{children:`contactId`}),` but no `,_jsx(_components.code,{children:`leadId`}),`, so `,_jsx(_components.code,{children:`leadFirstName`}),`, `,_jsx(_components.code,{children:`leadLastName`}),` and `,_jsx(_components.code,{children:`leadEmail`}),`\nare absent: there is no lead to take them from. `,_jsx(_components.code,{children:`firstName`}),`, `,_jsx(_components.code,{children:`lastName`}),` and\n`,_jsx(_components.code,{children:`email`}),` are still present, read from the contact. To get a name on every\nevent, read `,_jsx(_components.code,{children:`firstName`}),` / `,_jsx(_components.code,{children:`lastName`}),`, or `,_jsx(_components.code,{children:`leadFirstName`}),` / `,_jsx(_components.code,{children:`leadLastName`}),` with\na fallback to them.`]})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`stepId`}),` identifies the step itself, while `,_jsx(_components.code,{children:`sequenceStep`}),` is a position that\nshifts when a sequence’s steps are reordered — prefer `,_jsx(_components.code,{children:`stepId`}),` when you store a\nreference. Both are sent: `,_jsx(_components.code,{children:`sequenceStep`}),` is unchanged. `,_jsx(_components.code,{children:`stepId`}),` is present on\nevery activity created from now on, and older activities gain it progressively\nas historical records are backfilled.`]})}),`\n`,_jsxs(Heading,{level:`3`,id:`email-recipients-to-/-cc-/-bcc`,children:[`Email recipients (`,_jsx(_components.code,{children:`to`}),` / `,_jsx(_components.code,{children:`cc`}),` / `,_jsx(_components.code,{children:`bcc`}),`)`]}),`\n`,_jsxs(_components.p,{children:[`Email events (`,_jsx(_components.code,{children:`emailsSent`}),`, `,_jsx(_components.code,{children:`emailsReplied`}),`, `,_jsx(_components.code,{children:`emailsBounced`}),`) carry the full recipient lists as arrays of `,_jsx(_components.code,{children:`{address, name}`}),`. Addresses are lowercased. Fields are omitted when empty.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes dracula dracula`,style:{backgroundColor:`#282A36`,\"--shiki-dark-bg\":`#282A36`,color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`6`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:` \"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`type`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:` \"`}),_jsx(_components.span,{style:{color:`#F1FA8C`,\"--shiki-dark\":`#F1FA8C`},children:`emailsSent`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:`\"`}),_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:` \"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`to`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:` [{ `}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`address`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:` \"`}),_jsx(_components.span,{style:{color:`#F1FA8C`,\"--shiki-dark\":`#F1FA8C`},children:`lead@example.com`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:`\"`}),_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`, `}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`name`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:` \"`}),_jsx(_components.span,{style:{color:`#F1FA8C`,\"--shiki-dark\":`#F1FA8C`},children:`Alice Doe`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:`\"`}),_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:` }],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:` \"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`cc`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:` [{ `}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`address`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:` \"`}),_jsx(_components.span,{style:{color:`#F1FA8C`,\"--shiki-dark\":`#F1FA8C`},children:`manager@example.com`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:`\"`}),_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`, `}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`name`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:` \"\"`}),_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:` }],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:` \"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`bcc`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:` [{ `}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`address`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:` \"`}),_jsx(_components.span,{style:{color:`#F1FA8C`,\"--shiki-dark\":`#F1FA8C`},children:`archive@crm.io`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:`\"`}),_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`, `}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`name`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:` \"\"`}),_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:` }]`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`to`}),` — primary recipient(s). For outbound sends, this is the lead. For inbound replies, this is the mailbox owner; multi-recipient `,_jsx(_components.code,{children:`to`}),` lines (e.g. reply-all where the lead manually added people) are preserved.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`cc`}),` — explicit CC recipients on the email.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`bcc`}),` — only present for outbound `,_jsx(_components.code,{children:`emailsSent`}),` events when the sender has a hidden BCC configured in `,_jsx(_components.strong,{children:`Settings → Integrations`}),` (`,_jsx(_components.code,{children:`users.lemlist.bcc`}),`). Inbound BCC is never visible because SMTP strips it for non-BCC’d recipients.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`third-party-reply-flag`,children:`Third-party reply flag`}),`\n`,_jsxs(_components.p,{children:[`When a reply on a thread comes from an address that does `,_jsx(_components.strong,{children:`not`}),` match the original lead’s known contact emails, lemlist attributes the reply to the third-party sender rather than to the lead, and the event carries an extra flag:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes dracula dracula`,style:{backgroundColor:`#282A36`,\"--shiki-dark-bg\":`#282A36`,color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:` \"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`type`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:` \"`}),_jsx(_components.span,{style:{color:`#F1FA8C`,\"--shiki-dark\":`#F1FA8C`},children:`emailsReplied`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:`\"`}),_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:` \"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`isThirdPartyReply`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#BD93F9`,\"--shiki-dark\":`#BD93F9`},children:` true`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Third-party reply payloads omit `,_jsx(_components.code,{children:`campaignId`}),`, `,_jsx(_components.code,{children:`leadId`}),`, and `,_jsx(_components.code,{children:`sequenceId`}),` (since the reply is no longer attached to the original campaign flow). Use the flag to route these events differently if needed.`]}),`\n`,_jsx(Heading,{level:`2`,id:`examples`,children:`Examples`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`all events`,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes dracula dracula`,style:{backgroundColor:`#282A36`,\"--shiki-dark-bg\":`#282A36`,color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\t\"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`targetUrl`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:` \"`}),_jsx(_components.span,{style:{color:`#F1FA8C`,\"--shiki-dark\":`#F1FA8C`},children:`https://webhook.site/your-id`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:`\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`specific event and campaign`,numberOfLines:`6`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes dracula dracula`,style:{backgroundColor:`#282A36`,\"--shiki-dark-bg\":`#282A36`,color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`6`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\t\"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`targetUrl`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:` \"`}),_jsx(_components.span,{style:{color:`#F1FA8C`,\"--shiki-dark\":`#F1FA8C`},children:`https://webhook.site/your-id`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:`\"`}),_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\t\"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`type`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:` \"`}),_jsx(_components.span,{style:{color:`#F1FA8C`,\"--shiki-dark\":`#F1FA8C`},children:`linkedinInterested`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:`\"`}),_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\t\"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`campaignId`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:` \"`}),_jsx(_components.span,{style:{color:`#F1FA8C`,\"--shiki-dark\":`#F1FA8C`},children:`cam_A1B2C3D4E5F6G7H8I9`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:`\"`}),_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\t\"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`isFirst`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#BD93F9`,\"--shiki-dark\":`#BD93F9`},children:` true`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`whatsapp events`,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes dracula dracula`,style:{backgroundColor:`#282A36`,\"--shiki-dark-bg\":`#282A36`,color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\t\"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`targetUrl`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:` \"`}),_jsx(_components.span,{style:{color:`#F1FA8C`,\"--shiki-dark\":`#F1FA8C`},children:`https://webhook.site/your-id`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:`\"`}),_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\t\"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`type`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:` \"`}),_jsx(_components.span,{style:{color:`#F1FA8C`,\"--shiki-dark\":`#F1FA8C`},children:`whatsappReplied`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:`\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`signal agent signals`,numberOfLines:`8`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes dracula dracula`,style:{backgroundColor:`#282A36`,\"--shiki-dark-bg\":`#282A36`,color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`8`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\t\"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`targetUrl`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:` \"`}),_jsx(_components.span,{style:{color:`#F1FA8C`,\"--shiki-dark\":`#F1FA8C`},children:`https://webhook.site/your-id`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:`\"`}),_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\t\"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`type`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:` \"`}),_jsx(_components.span,{style:{color:`#F1FA8C`,\"--shiki-dark\":`#F1FA8C`},children:`signalRegistered`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:`\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#FF5555`,\"--shiki-light-font-style\":`italic`,\"--shiki-light-text-decoration\":`underline`,\"--shiki-dark\":`#FF5555`,\"--shiki-dark-font-style\":`italic`,\"--shiki-dark-text-decoration\":`underline`},children:\"```json\"}),_jsx(_components.span,{style:{color:`#FF5555`,\"--shiki-light-font-style\":`italic`,\"--shiki-light-text-decoration\":`underline`,\"--shiki-dark\":`#FF5555`,\"--shiki-dark-font-style\":`italic`,\"--shiki-dark-text-decoration\":`underline`},children:` with`}),_jsx(_components.span,{style:{color:`#FF5555`,\"--shiki-light-font-style\":`italic`,\"--shiki-light-text-decoration\":`underline`,\"--shiki-dark\":`#FF5555`,\"--shiki-dark-font-style\":`italic`,\"--shiki-dark-text-decoration\":`underline`},children:` shared`}),_jsx(_components.span,{style:{color:`#FF5555`,\"--shiki-light-font-style\":`italic`,\"--shiki-light-text-decoration\":`underline`,\"--shiki-dark\":`#FF5555`,\"--shiki-dark-font-style\":`italic`,\"--shiki-dark-text-decoration\":`underline`},children:` secret`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\t\"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`targetUrl`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:` \"`}),_jsx(_components.span,{style:{color:`#F1FA8C`,\"--shiki-dark\":`#F1FA8C`},children:`https://webhook.site/your-id`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:`\"`}),_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\t\"`}),_jsx(_components.span,{style:{color:`#8BE9FD`,\"--shiki-dark\":`#8BE9FD`},children:`secret`}),_jsx(_components.span,{style:{color:`#8BE9FE`,\"--shiki-dark\":`#8BE9FE`},children:`\"`}),_jsx(_components.span,{style:{color:`#FF79C6`,\"--shiki-dark\":`#FF79C6`},children:`:`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:` \"`}),_jsx(_components.span,{style:{color:`#F1FA8C`,\"--shiki-dark\":`#F1FA8C`},children:`s3cret-shared-with-my-endpoint`}),_jsx(_components.span,{style:{color:`#E9F284`,\"--shiki-dark\":`#E9F284`},children:`\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#F8F8F2`,\"--shiki-dark\":`#F8F8F2`},children:`}`})}),`\n`]})})})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Tip: You can include an optional `,_jsx(_components.code,{children:`zapId`}),` if you use Zapier to track the webhook mapping on your side.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{SnippetObjectReference,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"theme":"dracula"},"config":{},"pageMetadata":{"openapi":"post /hooks","description":"Creates a webhook that receives real-time POST callbacks for selected events.","title":"Add Webhook","href":"/api-reference/endpoints/webhooks/add-webhook"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[158,1036,")=>null;function _cr"]]},"mdxExtracts":{"tableOfContents":[{"title":"Limits and conflicts","slug":"limits-and-conflicts","depth":2,"children":[{"title":"Disabled webhooks still count toward the cap","slug":"disabled-webhooks-still-count-toward-the-cap","depth":3,"children":[]}]},{"title":"Available event types","slug":"available-event-types","depth":2,"children":[{"title":"Lead state groups","slug":"lead-state-groups","depth":3,"children":[]},{"title":"Email activities","slug":"email-activities","depth":3,"children":[]},{"title":"Unsubscribe activities","slug":"unsubscribe-activities","depth":3,"children":[]},{"title":"LinkedIn activities","slug":"linkedin-activities","depth":3,"children":[]},{"title":"WhatsApp activities","slug":"whatsapp-activities","depth":3,"children":[]},{"title":"SMS activities","slug":"sms-activities","depth":3,"children":[]},{"title":"Call activities","slug":"call-activities","depth":3,"children":[]},{"title":"API activities","slug":"api-activities","depth":3,"children":[]},{"title":"Manual activities","slug":"manual-activities","depth":3,"children":[]},{"title":"Task activities","slug":"task-activities","depth":3,"children":[]},{"title":"Workspace activities","slug":"workspace-activities","depth":3,"children":[]},{"title":"Enrichment","slug":"enrichment","depth":3,"children":[]},{"title":"Contact sourcing","slug":"contact-sourcing","depth":3,"children":[]},{"title":"Inbox activities","slug":"inbox-activities","depth":3,"children":[]},{"title":"Signal Agents","slug":"signal-agents","depth":3,"children":[]},{"title":"Deliverability hub","slug":"deliverability-hub","depth":3,"children":[]},{"title":"Deprecated events","slug":"deprecated-events","depth":3,"children":[]}]},{"title":"Verifying webhook authenticity","slug":"verifying-webhook-authenticity","depth":2,"children":[]},{"title":"Webhook payload","slug":"webhook-payload","depth":2,"children":[{"title":"Email recipients (to / cc / bcc)","slug":"email-recipients-to-/-cc-/-bcc","depth":3,"children":[]},{"title":"Third-party reply flag","slug":"third-party-reply-flag","depth":3,"children":[]}]},{"title":"Examples","slug":"examples","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/lemlist/a773d8a119273e17/scripts/playground-captions.js","/_mintlify/custom/lemlist/7d1b4a0d04d1528d/scripts/copy-page-url.js"],"openApiReferenceData":{"operation":{"summary":"Add Webhook","tags":["Webhooks"],"parameters":["2c5a47fc-486d-4c63-a522-b8709de5b7f4","34f91aea-d675-4bcb-9045-9806dedda7d3","b5a66a65-57f0-44d6-a0fb-583bab1e8157"],"requestBody":"8a894460-da19-4542-90af-9fe90e8d2d5f","responses":{"200":"5aaa3eab-23b5-4fe8-a2c2-5a2f33108087","400":"b9cee8c5-2276-48c7-8a62-254cfeab724d","401":"460975ad-419c-44bb-b692-7a75cfba4171","403":"ed17dcf3-d1d7-4c42-b6fd-e4869a1a5447","404":"67cf655d-7de1-42f7-8289-c0c4a36e4a48","409":"25738ba4-104b-4757-9c96-37cd01b8b855"},"method":"post","type":"path","servers":["ec612425-ecd6-4042-bb72-047155cb0841"],"security":["ae94ae04-13ac-40e0-924d-beffd3f8d9a3"],"path":"/hooks","baseUrlOptions":["https://api.lemlist.com/api"],"title":"Add Webhook","description":"Creates a webhook that receives real-time POST callbacks for selected events.","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","ruby","php"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.targetUrl":"https://webhook.site/00000000-0000-0000-0000-000000000000","body.type":"linkedinInterested","body.secret":"s3cret-shared-with-my-endpoint"}]},"dependencies":{"parameters":{"2c5a47fc-486d-4c63-a522-b8709de5b7f4":{"name":"campaignId","in":"query","required":false,"description":"Webhook for specific campaign","example":"cam_123","schema":{"type":"string","isRequired":false,"description":"Webhook for specific campaign","uniqueKey":"","typeLabel":"string"}},"34f91aea-d675-4bcb-9045-9806dedda7d3":{"name":"isFirst","in":"query","required":false,"description":"Webhook for first activity only","example":"true","schema":{"type":"boolean","isRequired":false,"description":"Webhook for first activity only","uniqueKey":"","typeLabel":"boolean"}},"b5a66a65-57f0-44d6-a0fb-583bab1e8157":{"name":"zapId","in":"query","required":false,"description":"Zapier ID","example":"123456789","schema":{"type":"string","isRequired":false,"description":"Zapier ID","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"targetUrl":{"type":"string","format":"uri","description":"The URL that will receive webhook POST requests.","isRequired":true,"uniqueKey":"targetUrl","typeLabel":"string\u003curi>"},"type":{"type":"string","description":"Optional event type to subscribe to. When omitted, all events are sent. See the full categorized list in the endpoint documentation.","enum":["contacted","hooked","attracted","warmed","interested","notInterested","emailsSent","emailsOpened","emailsClicked","emailsReplied","emailsBounced","emailsFailed","emailsInterested","emailsNotInterested","emailsUnsubscribed","entityUnsubscribed","variableUnsubscribed","linkedinSent","linkedinOpened","linkedinReplied","linkedinInterested","linkedinNotInterested","linkedinSendFailed","linkedinVisitDone","linkedinVisitFailed","linkedinFollowDone","linkedinFollowFailed","linkedinFollowSkipped","linkedinInviteDone","linkedinInviteFailed","linkedinInviteAccepted","linkedinEndorseDone","linkedinEndorseFailed","linkedinEndorseSkipped","linkedinVoiceNoteDone","linkedinVoiceNoteFailed","linkedinLikeLastPostDone","linkedinLikeLastPostNoPost","linkedinLikeLastPostFailed","linkedinWithdrawInvitationDone","linkedinWithdrawInvitationFailed","whatsappMessageSent","whatsappMessageDelivered","whatsappMessageOpened","whatsappReplied","whatsappMessageFailed","smsSent","smsDelivered","smsReplied","smsFailed","aircallCreated","aircallEnded","aircallDone","aircallInterested","aircallNotInterested","apiDone","apiInterested","apiNotInterested","apiFailed","manualInterested","manualNotInterested","paused","resumed","stopped","campaignComplete","customDomainErrors","connectionIssue","sendLimitReached","lemwarmPaused","annotated","enrichmentDone","enrichmentError","callRecordingDone","callTranscriptDone","inboxLabelUpdated","signalRegistered","deliverabilityAlertTriggered","contactSourcingDone","contactSourcingFailed"],"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"secret":{"type":"string","description":"Optional shared secret. Stored encrypted, never returned by GET, and immutable once set. Sent back to your endpoint as a `secret` field in the body of every webhook call so you can verify the request originated from lemlist.","uniqueKey":"secret","typeLabel":"string"}},"required":["targetUrl"],"uniqueKey":"","typeLabel":"object"},"example":{"targetUrl":"https://webhook.site/00000000-0000-0000-0000-000000000000","type":"linkedinInterested","secret":"s3cret-shared-with-my-endpoint"},"examples":{"Example":{"title":"Example","value":{"targetUrl":"https://webhook.site/00000000-0000-0000-0000-000000000000","type":"linkedinInterested","secret":"s3cret-shared-with-my-endpoint"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"5aaa3eab-23b5-4fe8-a2c2-5a2f33108087":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"_id":{"type":"string","description":"Unique identifier for the webhook","uniqueKey":"_id","typeLabel":"string"},"targetUrl":{"type":"string","description":"The URL where the webhook will send data","uniqueKey":"targetUrl","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the webhook was created","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"type":{"type":"string","description":"Type of webhook event","uniqueKey":"type","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"_id":"hoo_GvYkkWIcdPf2WsBDY","targetUrl":"https://n8n.example.com/webhook/lemlist-webhook-surprise","createdAt":"2025-10-29T00:47:42.035Z","type":"linkedinInterested"},"examples":{"Example":{"title":"Example","value":{"_id":"hoo_GvYkkWIcdPf2WsBDY","targetUrl":"https://n8n.example.com/webhook/lemlist-webhook-surprise","createdAt":"2025-10-29T00:47:42.035Z","type":"linkedinInterested"}}},"exampleType":"examples"}},"exampleType":"examples"},"b9cee8c5-2276-48c7-8a62-254cfeab724d":{"description":"Bad team","content":{"text/plain":{"example":"Bad team","examples":{"Example":{"title":"Example","value":"Bad team"}},"exampleType":"examples"}},"exampleType":"examples"},"460975ad-419c-44bb-b692-7a75cfba4171":{"description":"Unauthorized","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"ed17dcf3-d1d7-4c42-b6fd-e4869a1a5447":{"description":"The API key's user does not have the \"Edit integrations\" permission. Nothing is created or deleted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"You do not have permission to edit webhooks"},"examples":{"Example":{"title":"Example","value":{"error":"You do not have permission to edit webhooks"}}},"exampleType":"examples"}},"exampleType":"examples"},"67cf655d-7de1-42f7-8289-c0c4a36e4a48":{"description":"Webhook not found","content":{"text/plain":{"example":"Webhook not found","examples":{"Example":{"title":"Example","value":"Webhook not found"}},"exampleType":"examples"}},"exampleType":"examples"},"25738ba4-104b-4757-9c96-37cd01b8b855":{"description":"The webhook was not created. Two distinct cases, told apart by the `error` message: the workspace is at its webhook cap, or the `targetUrl` is already registered.","content":{"application/json":{"examples":{"tooManyWebhooks":{"title":"tooManyWebhooks","value":{"error":"Too many webhooks (max 200 per team, disabled webhooks included)"}},"duplicateTargetUrl":{"title":"duplicateTargetUrl","value":{"error":"A webhook with this targetUrl already exists"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"ae94ae04-13ac-40e0-924d-beffd3f8d9a3":{"basicAuth":{"type":"http","scheme":"basic","scopes":[],"schemeName":"basicAuth"}}},"servers":{"ec612425-ecd6-4042-bb72-047155cb0841":{"url":"https://api.lemlist.com/api"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","scopes":[],"schemeName":"basicAuth"},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"basicAuth","name":"Authorization"}],"title":"basicAuth"}]},"originalFileLocation":"api-reference/openapi/v2.json"},"subdomain":"lemlist","siteName":"lemlist Developer Docs","title":"Lemlist Developer Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T10:27:12.794Z","originalFileLocation":"api-reference/endpoints/webhooks/add-webhook.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Creates a webhook that receives real-time POST callbacks for selected events.\">\u003cmeta data-mint-head name=\"keywords\" content=\"outbound, outreach, sales, automation\">\u003cmeta data-mint-head name=\"application-name\" content=\"lemlist Developer Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Lemlist Developer Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"lemlist API helps you to automate your outreach, build powerful workflows, subscribe to alerts, enrich your database and much more. It is easy to integrate, try it out!\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"lemlist Developer Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.lemlist.com/api-reference/endpoints/webhooks/add-webhook\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://developer.lemlist.com/thumbnails/dark.jpeg\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Lemlist Developer Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"lemlist API helps you to automate your outreach, build powerful workflows, subscribe to alerts, enrich your database and much more. It is easy to integrate, try it out!\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://developer.lemlist.com/thumbnails/dark.jpeg\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"lemlist Developer Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#316bff\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"charset\" content=\"UTF-8\">\u003cmeta data-mint-head name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\u003cmeta data-mint-head name=\"googlebot\" content=\"index, follow\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"verification_token\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#000000\">\u003cmeta data-mint-head name=\"color-scheme\" content=\"light dark\">\u003cmeta data-mint-head name=\"format-detection\" content=\"telephone=no\">\u003cmeta data-mint-head name=\"referrer\" content=\"origin\">\u003cmeta data-mint-head name=\"refresh\" content=\"30\">\u003cmeta data-mint-head name=\"rating\" content=\"general\">\u003cmeta data-mint-head name=\"revisit-after\" content=\"7 days\">\u003cmeta data-mint-head name=\"language\" content=\"en\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.lemlist.com/api-reference/endpoints/webhooks/add-webhook\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/webhooks/add-webhook.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.lemlist.com/#organization\",\"name\":\"lemlist Developer Docs\",\"url\":\"https://developer.lemlist.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/lemlist/2iZ5pwNAqbuSITlr/logo/light.svg?fit=max\u0026auto=format\u0026n=2iZ5pwNAqbuSITlr\u0026q=85\u0026s=788986080ad8b8885e095b71df22a88c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.lemlist.com#website\",\"name\":\"lemlist Developer Docs\",\"url\":\"https://developer.lemlist.com\",\"publisher\":{\"@id\":\"https://developer.lemlist.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.lemlist.com/api-reference/endpoints/webhooks/add-webhook#webpage\",\"url\":\"https://developer.lemlist.com/api-reference/endpoints/webhooks/add-webhook\",\"name\":\"Add Webhook\",\"description\":\"Creates a webhook that receives real-time POST callbacks for selected events.\",\"dateModified\":\"2026-10-28T10:27:12.794Z\",\"isPartOf\":{\"@id\":\"https://developer.lemlist.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.lemlist.com/api-reference/endpoints/webhooks/add-webhook#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.lemlist.com/api-reference/endpoints/webhooks/add-webhook#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Popular Resources\",\"item\":\"https://developer.lemlist.com/api-reference/endpoints/leads/create-lead-in-campaign\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Add Webhook\",\"item\":\"https://developer.lemlist.com/api-reference/endpoints/webhooks/add-webhook\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.lemlist.com/api-reference/endpoints/webhooks/add-webhook#apireference\",\"headline\":\"Add Webhook\",\"name\":\"Add Webhook\",\"description\":\"Creates a webhook that receives real-time POST callbacks for selected events.\",\"url\":\"https://developer.lemlist.com/api-reference/endpoints/webhooks/add-webhook\",\"mainEntityOfPage\":{\"@id\":\"https://developer.lemlist.com/api-reference/endpoints/webhooks/add-webhook#webpage\"},\"image\":\"https://developer.lemlist.com/thumbnails/dark.jpeg\",\"dateModified\":\"2026-10-28T10:27:12.794Z\",\"publisher\":{\"@id\":\"https://developer.lemlist.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.lemlist.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"lemlist Developer Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"lemlist Developer Docs","nav":{"global":{"versions":[{"version":"v2","default":false,"hidden":false,"href":"https://developer.lemlist.com/"}],"anchors":[{"anchor":"Start lemlist free trial","icon":"play","href":"https://app.lemlist.com/create-account"},{"anchor":"Talk to a human","icon":"headphones","href":"https://www.lemlist.com/contact-sales?r=0"}]},"tabs":[{"tab":"API Reference","groups":[{"group":"Getting started","pages":[{"title":"Overview","href":"/api-reference/getting-started/overview"},{"title":"Authentication","href":"/api-reference/getting-started/authentication"},{"title":"Managing multiple accounts","href":"/api-reference/getting-started/multiple-accounts"},{"title":"Rate Limits","href":"/api-reference/getting-started/rate-limits"}]},{"group":"Popular Resources","pages":[{"title":"Create Lead in Campaign","openapi":"post /campaigns/{campaignId}/leads/","href":"/api-reference/endpoints/leads/create-lead-in-campaign"},{"title":"Enrich Data","openapi":"post /enrich","href":"/api-reference/endpoints/enrich/enrich-data"},{"openapi":"post /database/people","description":"Searches the people database using filters, keywords, and pagination.","title":"Search People database","href":"/api-reference/endpoints/people-database/search-people-database"},{"openapi":"post /hooks","title":"Add Webhook","href":"/api-reference/endpoints/webhooks/add-webhook"},{"openapi":"get /leads/{email}","description":"Retrieves a specific lead by their email address.","title":"Get Lead by Email","href":"/api-reference/endpoints/leads/get-lead-by-email"}]},{"group":"Endpoints","pages":[{"group":"Team","expanded":false,"pages":[{"openapi":"get /team","title":"Get Team","href":"/api-reference/endpoints/team/get-team"},{"openapi":"get /team/senders","title":"Get Team Senders","href":"/api-reference/endpoints/team/get-team-senders"},{"openapi":"get /team/credits","title":"Get Team Credits","href":"/api-reference/endpoints/team/get-team-credits"}]},{"group":"Users","expanded":false,"pages":[{"openapi":"get /users/{userId}","title":"Get User","href":"/api-reference/endpoints/users/get-user"},{"openapi":"get /user/channels","title":"Get User Channels","href":"/api-reference/endpoints/users/get-user-channels"},{"openapi":"patch /users/{userId}/linkedin-limits","title":"Update User LinkedIn Limits","href":"/api-reference/endpoints/users/update-user-linkedin-limits"},{"openapi":"get /users/{userId}/signature","title":"Get User Signature","href":"/api-reference/endpoints/users/get-user-signature"},{"openapi":"patch /users/{userId}/signature","title":"Update User Signature","href":"/api-reference/endpoints/users/update-user-signature"}]},{"group":"Email Accounts","expanded":false,"pages":[{"openapi":"post /user/email-accounts","title":"Connect Email Account","href":"/api-reference/endpoints/email-accounts/connect-email-account"},{"openapi":"delete /user/email-accounts/{emailAccountId}","title":"Disconnect Email Account","href":"/api-reference/endpoints/email-accounts/disconnect-email-account"},{"openapi":"post /user/email-accounts/{emailAccountId}/test","title":"Test Email Account","href":"/api-reference/endpoints/email-accounts/test-email-account"}]},{"group":"Campaigns","expanded":false,"pages":[{"openapi":"post /campaigns","title":"Create Campaign","href":"/api-reference/endpoints/campaigns/create-campaign"},{"openapi":"get /campaigns/{campaignId}","title":"Get Campaign","href":"/api-reference/endpoints/campaigns/get-campaign"},{"openapi":"get /campaigns","title":"Get Many Campaigns","href":"/api-reference/endpoints/campaigns/get-many-campaigns"},{"openapi":"patch /campaigns/{campaignId}","title":"Update Campaign","href":"/api-reference/endpoints/campaigns/update-campaign"},{"openapi":"get /campaigns/{campaignId}/settings","title":"Get Campaign Settings","href":"/api-reference/endpoints/campaigns/get-campaign-settings"},{"openapi":"patch /campaigns/{campaignId}/settings","title":"Update Campaign Settings","href":"/api-reference/endpoints/campaigns/update-campaign-settings"},{"openapi":"get /campaigns/{campaignId}/statutes","title":"Get Campaign Statutes","href":"/api-reference/endpoints/campaigns/get-campaign-statutes"},{"openapi":"post /campaigns/{campaignId}/start","title":"Start Campaign","href":"/api-reference/endpoints/campaigns/start-campaign"},{"openapi":"post /campaigns/{campaignId}/pause","title":"Pause Campaign","href":"/api-reference/endpoints/campaigns/pause-campaign"},{"openapi":"post /campaigns/{campaignId}/archive","title":"Archive Campaign","href":"/api-reference/endpoints/campaigns/archive-campaign"},{"openapi":"post /campaigns/{campaignId}/unarchive","title":"Unarchive Campaign","href":"/api-reference/endpoints/campaigns/unarchive-campaign"},{"openapi":"post /campaigns/{campaignId}/steps/{stepId}/skip","title":"Skip Step for Everyone","href":"/api-reference/endpoints/campaigns/skip-step-for-everyone"},{"openapi":"post /campaigns/{campaignId}/steps/{stepId}/skip-for-leads","title":"Skip Step for Leads","href":"/api-reference/endpoints/campaigns/skip-step-for-leads"},{"openapi":"post /campaigns/{campaignId}/abm-leads","title":"Add ABM Campaign Leads","href":"/api-reference/endpoints/campaigns/add-abm-campaign-leads"},{"openapi":"post /campaigns/{campaignId}/triggers/watch-lists","title":"Add Signal Agent Trigger","href":"/api-reference/endpoints/campaigns/add-watch-list-trigger"},{"openapi":"delete /campaigns/{campaignId}/triggers/watch-lists/{watchListId}","title":"Remove Signal Agent Trigger","href":"/api-reference/endpoints/campaigns/remove-watch-list-trigger"},{"openapi":"post /campaigns/{campaignId}/duplicate","title":"Duplicate Campaign","href":"/api-reference/endpoints/campaigns/duplicate-campaign"},{"openapi":"get /v2/campaigns/{campaignId}/stats","title":"Get Campaign Stats","href":"/api-reference/endpoints/campaigns/get-campaign-stats"},{"openapi":"post /v2/campaigns/stats/batch","title":"Get Batch Campaign Stats","href":"/api-reference/endpoints/campaigns/get-batch-campaign-stats"},{"openapi":"get /campaigns/{campaignId}/export/start","title":"Start Campaign Stats Export","href":"/api-reference/endpoints/campaigns/start-campaign-export"},{"openapi":"get /campaigns/{campaignId}/export/{exportId}/status","title":"Get Campaign Export Status","href":"/api-reference/endpoints/campaigns/get-campaign-export-status"},{"openapi":"put /campaigns/{campaignId}/export/{exportId}/email/{email}","title":"Set Email for Campaign Export Notification","href":"/api-reference/endpoints/campaigns/set-export-email-notification"},{"openapi":"get /v2/campaigns/{campaignId}/export/leads","title":"Export Campaign Leads","href":"/api-reference/endpoints/campaigns/export-campaign-leads-v2"},{"openapi":"get /campaigns/{campaignId}/export/leads","title":"Export Campaign Leads (legacy)","href":"/api-reference/endpoints/campaigns/export-campaign-leads"},{"openapi":"get /campaigns/reports","title":"Get Campaign Reports","href":"/api-reference/endpoints/campaigns/get-campaign-reports"}]},{"group":"Senders","expanded":false,"pages":[{"openapi":"get /senders","title":"List Senders","href":"/api-reference/endpoints/senders/list-senders"},{"openapi":"get /campaigns/{campaignId}/senders","title":"Get Campaign Senders","href":"/api-reference/endpoints/senders/get-campaign-senders"},{"openapi":"post /campaigns/{campaignId}/senders","title":"Add Campaign Senders","href":"/api-reference/endpoints/senders/add-campaign-senders"},{"openapi":"put /campaigns/{campaignId}/senders","title":"Replace Campaign Senders","href":"/api-reference/endpoints/senders/replace-campaign-senders"},{"openapi":"patch /campaigns/{campaignId}/senders/{userId}","title":"Update Campaign Sender Channels","href":"/api-reference/endpoints/senders/update-campaign-sender-channels"},{"openapi":"delete /campaigns/{campaignId}/senders/{userId}","title":"Remove Campaign Sender","href":"/api-reference/endpoints/senders/remove-campaign-sender"},{"openapi":"get /team/dynamic-sender-exclusions","title":"Get Team Sender Exclusions","href":"/api-reference/endpoints/senders/get-team-sender-exclusions"},{"openapi":"put /team/dynamic-sender-exclusions","title":"Replace Team Sender Exclusions","href":"/api-reference/endpoints/senders/replace-team-sender-exclusions"},{"openapi":"get /campaigns/{campaignId}/dynamic-sender-exclusions","title":"Get Campaign Sender Exclusions","href":"/api-reference/endpoints/senders/get-campaign-sender-exclusions"},{"openapi":"put /campaigns/{campaignId}/dynamic-sender-exclusions","title":"Replace Campaign Sender Exclusions","href":"/api-reference/endpoints/senders/replace-campaign-sender-exclusions"}]},{"group":"Sequences","expanded":false,"pages":[{"openapi":"get /campaigns/{campaignId}/sequences","title":"Get Campaign Sequences","href":"/api-reference/endpoints/sequences/get-campaign-sequences"},{"openapi":"post /sequences/{sequenceId}/steps","title":"Add Step to Sequence","href":"/api-reference/endpoints/sequences/add-step-to-sequence"},{"openapi":"patch /sequences/{sequenceId}/steps/{stepId}","title":"Update Sequence Step","href":"/api-reference/endpoints/sequences/update-sequence-step"},{"openapi":"delete /sequences/{sequenceId}/steps/{stepId}","title":"Delete Sequence Step","href":"/api-reference/endpoints/sequences/delete-sequence-step"},{"openapi":"get /sequences/{sequenceId}/steps/{stepId}/sender","title":"Get Step Sender","href":"/api-reference/endpoints/sequences/get-step-sender"},{"openapi":"put /sequences/{sequenceId}/steps/{stepId}/sender","title":"Set Step Sender","href":"/api-reference/endpoints/sequences/set-step-sender"},{"openapi":"delete /sequences/{sequenceId}/steps/{stepId}/sender","title":"Remove Step Sender","href":"/api-reference/endpoints/sequences/remove-step-sender"},{"openapi":"get /sequences/{sequenceId}/steps/{stepId}/branches","title":"List Condition Branches","href":"/api-reference/endpoints/sequences/list-condition-branches"},{"openapi":"post /sequences/{sequenceId}/steps/{stepId}/branches","title":"Add Condition Branch","href":"/api-reference/endpoints/sequences/add-condition-branch"},{"openapi":"patch /sequences/{sequenceId}/steps/{stepId}/branches","title":"Reorder Condition Branches","href":"/api-reference/endpoints/sequences/reorder-condition-branches"},{"openapi":"patch /sequences/{sequenceId}/steps/{stepId}/branches/{branchSequenceId}","title":"Update Condition Branch","href":"/api-reference/endpoints/sequences/update-condition-branch"},{"openapi":"delete /sequences/{sequenceId}/steps/{stepId}/branches/{branchSequenceId}","title":"Delete Condition Branch","href":"/api-reference/endpoints/sequences/delete-condition-branch"},{"openapi":"post /sequences/{sequenceId}/steps/{stepId}/ab-test","title":"Create A/B Test Variant","href":"/api-reference/endpoints/sequences/create-ab-test-variant"},{"openapi":"get /sequences/{sequenceId}/steps/{stepId}/ab-test","title":"Get A/B Test Variant","href":"/api-reference/endpoints/sequences/get-ab-test-variant"},{"openapi":"patch /sequences/{sequenceId}/steps/{stepId}/ab-test","title":"Update A/B Test Variant","href":"/api-reference/endpoints/sequences/update-ab-test-variant"},{"openapi":"delete /sequences/{sequenceId}/steps/{stepId}/ab-test","title":"Delete A/B Test Variant","href":"/api-reference/endpoints/sequences/delete-ab-test-variant"},{"openapi":"post /sequences/{sequenceId}/steps/{stepId}/ab-test/winner","title":"Select A/B Test Winner","href":"/api-reference/endpoints/sequences/select-ab-test-winner"}]},{"group":"Message templates","expanded":false,"pages":[{"openapi":"get /message-templates","title":"List Message Templates","href":"/api-reference/endpoints/message-templates/list-message-templates"},{"openapi":"get /message-templates/tags","title":"List Message Template Tags","href":"/api-reference/endpoints/message-templates/list-message-template-tags"},{"openapi":"get /message-templates/{templateId}","title":"Get Message Template","href":"/api-reference/endpoints/message-templates/get-message-template"}]},{"group":"Snippets","expanded":false,"pages":[{"openapi":"get /snippets","title":"List Snippets","href":"/api-reference/endpoints/snippets/list-snippets"},{"openapi":"get /snippets/{snippetId}","title":"Get Snippet","href":"/api-reference/endpoints/snippets/get-snippet"}]},{"group":"Schedules","expanded":false,"pages":[{"openapi":"post /schedules","title":"Create Schedule","href":"/api-reference/endpoints/schedules/create-schedule"},{"openapi":"get /schedules/{scheduleId}","title":"Get Schedule","href":"/api-reference/endpoints/schedules/get-schedule"},{"openapi":"get /schedules","title":"Get Many Schedules","href":"/api-reference/endpoints/schedules/get-many-schedules"},{"openapi":"patch /schedules/{scheduleId}","title":"Update Schedule","href":"/api-reference/endpoints/schedules/update-schedule"},{"openapi":"delete /schedules/{scheduleId}","title":"Delete Schedule","href":"/api-reference/endpoints/schedules/delete-schedule"},{"openapi":"get /campaigns/{campaignId}/schedules/","title":"Get Campaign Schedules","href":"/api-reference/endpoints/schedules/get-campaign-schedules"},{"openapi":"post /campaigns/{campaignId}/schedules/{scheduleId}","title":"Associate Schedule with Campaign","href":"/api-reference/endpoints/schedules/associate-schedule-with-campaign"}]},{"group":"Leads","expanded":false,"pages":[{"title":"Create Lead in Campaign","openapi":"post /campaigns/{campaignId}/leads/","href":"/api-reference/endpoints/leads/create-lead-in-campaign"},{"openapi":"get /campaigns/{campaignId}/leads/","title":"Get Campaign Leads","href":"/api-reference/endpoints/leads/get-campaign-leads"},{"openapi":"get /leads","title":"Get Lead by Email or ID","href":"/api-reference/endpoints/leads/get-lead-by-email-or-id"},{"openapi":"get /leads/{email}","title":"Get Lead by Email","href":"/api-reference/endpoints/leads/get-lead-by-email"},{"openapi":"patch /campaigns/{campaignId}/leads/{leadId}","title":"Update Lead in a Campaign","href":"/api-reference/endpoints/leads/update-lead"},{"openapi":"delete /campaigns/{campaignId}/leads/{leadId}","title":"Delete or Unsubscribe Lead","href":"/api-reference/endpoints/leads/delete-lead"},{"openapi":"post /leads/{leadId}/variables","title":"Add Custom Variables on Leads","href":"/api-reference/endpoints/leads/add-lead-variables"},{"openapi":"patch /leads/{leadId}/variables","title":"Update Values of Custom Variables of a Lead","href":"/api-reference/endpoints/leads/update-lead-variables"},{"openapi":"delete /leads/{leadId}/variables","title":"Erase Values of Custom Variables on a Lead","href":"/api-reference/endpoints/leads/delete-lead-variables"},{"openapi":"delete /campaigns/{campaignId}/leads/{email}","title":"Unsubscribe Lead from Campaign","href":"/api-reference/endpoints/leads/unsubscribe-lead-from-campaign"},{"openapi":"post /leads/pause/{leadId}","title":"Pause Lead","href":"/api-reference/endpoints/leads/pause-lead"},{"openapi":"post /leads/start/{leadId}","title":"Resume Paused Lead","href":"/api-reference/endpoints/leads/resume-paused-lead"},{"openapi":"post /leads/review/{leadId}","title":"Launch Lead","href":"/api-reference/endpoints/leads/launch-lead"},{"openapi":"post /leads/interested/{leadIdOrEmail}","title":"Mark Lead as Interested","href":"/api-reference/endpoints/leads/mark-lead-as-interested"},{"openapi":"post /leads/notinterested/{leadIdOrEmail}","title":"Mark Lead as Not Interested","href":"/api-reference/endpoints/leads/mark-lead-as-not-interested"},{"openapi":"post /campaigns/{campaignId}/leads/{leadIdOrEmail}/interested","title":"Mark Lead as Interested in Campaign","href":"/api-reference/endpoints/leads/mark-lead-as-interested-in-campaign"},{"openapi":"post /campaigns/{campaignId}/leads/{leadIdOrEmail}/notinterested","title":"Mark Lead as Not Interested in Campaign","href":"/api-reference/endpoints/leads/mark-lead-as-not-interested-in-campaign"},{"openapi":"post /campaigns/{campaignId}/leads/{leadIdOrEmail}/steps/{stepId}/skip","title":"Skip Step for Lead","href":"/api-reference/endpoints/leads/skip-step-for-lead"},{"openapi":"put /campaigns/{campaignId}/leads/{leadIdOrEmail}/steps/{stepId}/personalization","title":"Personalize Step for Lead","href":"/api-reference/endpoints/leads/personalize-step-for-lead"},{"openapi":"delete /campaigns/{campaignId}/leads/{leadIdOrEmail}/steps/{stepId}/personalization","title":"Reset Step Personalization for Lead","href":"/api-reference/endpoints/leads/reset-step-personalization-for-lead"},{"openapi":"post /campaigns/{campaignId}/leads/import","title":"Import Leads from CRM","href":"/api-reference/endpoints/leads/import-leads-from-crm"},{"openapi":"post /leads/audio","title":"Upload Audio for Voice Message Step","href":"/api-reference/endpoints/leads/upload-audio-for-voice-message-step"}]},{"group":"Companies","expanded":false,"pages":[{"openapi":"post /companies","title":"Add and update company","href":"/api-reference/endpoints/companies/upsert-company"},{"openapi":"get /companies/{companyId}","title":"Get Company","href":"/api-reference/endpoints/companies/get-company"},{"openapi":"get /companies","title":"Get Many Companies","href":"/api-reference/endpoints/companies/get-many-companies"},{"openapi":"delete /companies/{companyId}","title":"Delete Company","href":"/api-reference/endpoints/companies/delete-company"},{"openapi":"post /companies/merge","title":"Merge Companies","href":"/api-reference/endpoints/companies/merge-companies"},{"openapi":"post /companies/crm/search-and-connect","title":"Search \u0026 Connect Companies in the CRM","href":"/api-reference/endpoints/companies/search-and-connect-companies"},{"openapi":"post /companies/crm/create","title":"Create Companies in the CRM","href":"/api-reference/endpoints/companies/create-companies-in-crm"},{"openapi":"get /companies/lists","title":"Get Company Lists","href":"/api-reference/endpoints/companies/get-company-lists"},{"openapi":"post /companies/lists","title":"Create Company List","href":"/api-reference/endpoints/companies/create-company-list"},{"openapi":"post /companies/lists/{listId}/entities","title":"Add or Remove Companies in a List","href":"/api-reference/endpoints/companies/manage-company-list-entities"},{"openapi":"post /companies/{companyId}/notes","title":"Create Company Note","href":"/api-reference/endpoints/companies/create-company-note"},{"openapi":"get /companies/{companyId}/notes","title":"Get Company Notes","href":"/api-reference/endpoints/companies/get-company-notes"}]},{"group":"Contacts","expanded":false,"pages":[{"openapi":"post /contacts","title":"Add and update contact","href":"/api-reference/endpoints/contacts/upsert-contact"},{"openapi":"get /contacts/{idOrEmail}","title":"Get Contact","href":"/api-reference/endpoints/contacts/get-contact"},{"openapi":"get /contacts","title":"Get Many Contacts","href":"/api-reference/endpoints/contacts/get-many-contacts"},{"openapi":"delete /contacts/{idOrEmail}","title":"Delete Contact","href":"/api-reference/endpoints/contacts/delete-contact"},{"openapi":"post /contacts/merge","title":"Merge Contacts","href":"/api-reference/endpoints/contacts/merge-contacts"},{"openapi":"post /contacts/crm/search-and-connect","title":"Search \u0026 Connect Contacts in the CRM","href":"/api-reference/endpoints/contacts/search-and-connect-contacts"},{"openapi":"post /contacts/crm/create","title":"Create Contacts in the CRM","href":"/api-reference/endpoints/contacts/create-contacts-in-crm"},{"openapi":"get /contacts/lists","title":"Get Contact Lists","href":"/api-reference/endpoints/contacts/get-contact-lists"},{"openapi":"post /contacts/lists","title":"Create Contact List","href":"/api-reference/endpoints/contacts/create-contact-list"},{"openapi":"post /contacts/lists/{listId}/entities","title":"Add or Remove Contacts in a List","href":"/api-reference/endpoints/contacts/manage-contact-list-entities"},{"openapi":"get /contacts/export","title":"Export Contact List","href":"/api-reference/endpoints/contacts/export-contact-list"},{"openapi":"post /contacts/{idOrEmail}/notes","title":"Create Contact Note","href":"/api-reference/endpoints/contacts/create-contact-note"},{"openapi":"get /contacts/{idOrEmail}/notes","title":"Get Contact Notes","href":"/api-reference/endpoints/contacts/get-contact-notes"}]},{"group":"Inbox","expanded":false,"pages":[{"openapi":"get /inbox","title":"Get Many Inboxes","href":"/api-reference/endpoints/inbox/get-many-inboxes"},{"openapi":"get /inbox/{contactId}","title":"Get Contact Messages","href":"/api-reference/endpoints/inbox/get-contact-messages"},{"openapi":"post /inbox/email","title":"Send Email","href":"/api-reference/endpoints/inbox/send-email"},{"openapi":"post /inbox/linkedin","title":"Send LinkedIn Message","href":"/api-reference/endpoints/inbox/send-linkedin-message"},{"openapi":"post /inbox/whatsapp","title":"Send WhatsApp Message","href":"/api-reference/endpoints/inbox/send-whatsapp-message"},{"openapi":"post /inbox/sms","title":"Send SMS Message","href":"/api-reference/endpoints/inbox/send-sms-message"},{"openapi":"get /inbox/labels","title":"Get Many Labels","href":"/api-reference/endpoints/inbox/get-many-labels"},{"openapi":"get /inbox/labels/{labelId}","title":"Get Label","href":"/api-reference/endpoints/inbox/get-label"},{"openapi":"post /inbox/labels","title":"Create Label","href":"/api-reference/endpoints/inbox/create-label"},{"openapi":"post /inbox/conversations/labels/{contactId}","title":"Attach Labels to Conversations","href":"/api-reference/endpoints/inbox/attach-labels-to-conversations"},{"openapi":"delete /inbox/conversations/labels/{contactId}","title":"Remove Labels from Conversation","href":"/api-reference/endpoints/inbox/remove-labels-from-conversation"},{"openapi":"get /inbox/{contactId}/drafts","title":"List Drafts","href":"/api-reference/endpoints/inbox/list-drafts"},{"openapi":"get /inbox/{contactId}/drafts/{draftId}","title":"Get Draft","href":"/api-reference/endpoints/inbox/get-draft"},{"openapi":"post /inbox/{contactId}/drafts","title":"Create Draft","href":"/api-reference/endpoints/inbox/create-draft"},{"openapi":"patch /inbox/{contactId}/drafts/{draftId}","title":"Update Draft","href":"/api-reference/endpoints/inbox/update-draft"},{"openapi":"delete /inbox/{contactId}/drafts/{draftId}","title":"Delete Draft","href":"/api-reference/endpoints/inbox/delete-draft"}]},{"group":"Tasks","expanded":false,"pages":[{"title":"Create Task","openapi":"post /tasks","href":"/api-reference/endpoints/tasks/create-task"},{"openapi":"get /v2/tasks","title":"Search Tasks","href":"/api-reference/endpoints/tasks/get-many-tasks-v2"},{"openapi":"get /v2/tasks/filters","title":"List Task Filters","href":"/api-reference/endpoints/tasks/get-task-filters"},{"openapi":"get /tasks","title":"Get Many Tasks","href":"/api-reference/endpoints/tasks/get-many-tasks"},{"openapi":"patch /tasks","title":"Update Task","href":"/api-reference/endpoints/tasks/update-task"},{"openapi":"post /tasks/ignore","title":"Ignore Tasks","href":"/api-reference/endpoints/tasks/ignore-tasks"}]},{"group":"Activities","expanded":false,"pages":[{"openapi":"get /activities","title":"Get Many Activities","href":"/api-reference/endpoints/activities/get-many-activities"},{"openapi":"delete /activities/{activityId}/recording-transcript","title":"Delete Activity Recording \u0026 Transcript","href":"/api-reference/endpoints/activities/delete-activity-recording-transcript"}]},{"group":"Calls","expanded":false,"pages":[{"openapi":"post /calls","title":"Log a Call","href":"/api-reference/endpoints/calls/log-call"},{"openapi":"patch /calls/{id}","title":"Update a Call","href":"/api-reference/endpoints/calls/update-call"},{"openapi":"get /calls/{id}","title":"Get a Call","href":"/api-reference/endpoints/calls/get-call"},{"openapi":"get /call-statuses","title":"Get Call Statuses","href":"/api-reference/endpoints/calls/get-call-statuses"}]},{"group":"CRMs","expanded":false,"pages":[{"openapi":"get /team/crmUsers","title":"Get Team CRM Users","href":"/api-reference/endpoints/crm/get-team-crm-users"},{"openapi":"get /crm/filters","title":"Get CRM Filters","href":"/api-reference/endpoints/crm/get-crm-filters"},{"openapi":"get /v2/crm/logs","title":"Get CRM Logs","href":"/api-reference/endpoints/crm/get-crm-logs"}]},{"group":"Unsubscribes","expanded":false,"pages":[{"group":"Variables","pages":[{"openapi":"get /v2/unsubscribes/variables","title":"List Unsubscribed Variables","href":"/api-reference/endpoints/unsubscribes/list-unsubscribed-variables"},{"openapi":"get /v2/unsubscribes/variables/{value}","title":"Get Unsubscribed Variable","href":"/api-reference/endpoints/unsubscribes/get-unsubscribed-variable"},{"openapi":"post /v2/unsubscribes/variables/{value}","title":"Unsubscribe Variable","href":"/api-reference/endpoints/unsubscribes/unsubscribe-variable"},{"openapi":"post /v2/unsubscribes/variables","title":"Bulk Unsubscribe Variables","href":"/api-reference/endpoints/unsubscribes/bulk-unsubscribe-variables"},{"openapi":"delete /v2/unsubscribes/variables/{value}","title":"Re-subscribe Variable","href":"/api-reference/endpoints/unsubscribes/resubscribe-variable"},{"openapi":"get /v2/unsubscribes/exports/variables","title":"Export Unsubscribed Variables","href":"/api-reference/endpoints/unsubscribes/export-unsubscribed-variables"}]},{"group":"Contacts","pages":[{"openapi":"get /v2/unsubscribes/contacts/{contactId}","title":"Get Contact Subscription Status","href":"/api-reference/endpoints/unsubscribes/get-contact-subscription-status"},{"openapi":"post /v2/unsubscribes/contacts/{contactId}","title":"Unsubscribe Contact","href":"/api-reference/endpoints/unsubscribes/unsubscribe-contact"},{"openapi":"delete /v2/unsubscribes/contacts/{contactId}","title":"Re-subscribe Contact","href":"/api-reference/endpoints/unsubscribes/resubscribe-contact"},{"openapi":"get /v2/unsubscribes/exports/contacts","description":"Exports all contacts with their subscription status as CSV (default) or JSON.","title":"Export Unsubscribed Contacts","href":"/api-reference/endpoints/unsubscribes/export-unsubscribed-contacts"}]}]},{"group":"Webhooks","expanded":false,"pages":[{"openapi":"post /hooks","title":"Add Webhook","href":"/api-reference/endpoints/webhooks/add-webhook"},{"openapi":"delete /hooks/{hookId}","description":"Deletes a specific webhook.","title":"Delete Webhook","href":"/api-reference/endpoints/webhooks/delete-webhook"},{"openapi":"get /hooks","title":"Get Many Webhooks","href":"/api-reference/endpoints/webhooks/get-many-webhooks"}]},{"group":"People database","expanded":false,"pages":[{"openapi":"post /database/people","title":"Search People database","href":"/api-reference/endpoints/people-database/search-people-database"},{"openapi":"post /database/people/linkedin-post-engagement","title":"Search LinkedIn post engagers","href":"/api-reference/endpoints/people-database/search-linkedin-post-engagers"},{"openapi":"post /database/companies","title":"Search Companies Database","href":"/api-reference/endpoints/people-database/search-companies-database"},{"openapi":"get /database/people/export","title":"Export People database","href":"/api-reference/endpoints/people-database/export-people-database"},{"openapi":"get /database/companies/export","title":"Export Companies database","href":"/api-reference/endpoints/people-database/export-companies-database"},{"openapi":"get /database/filters","title":"Get Database Filters","href":"/api-reference/endpoints/people-database/get-database-filters"},{"openapi":"get /database/personas","title":"List Personas","href":"/api-reference/endpoints/people-database/list-personas"},{"openapi":"post /database/personas","title":"Create Persona","href":"/api-reference/endpoints/people-database/create-persona"},{"openapi":"delete /database/personas/{personaId}","title":"Delete Persona","href":"/api-reference/endpoints/people-database/delete-persona"},{"openapi":"get /database/saved-searches","title":"List Saved Searches","href":"/api-reference/endpoints/people-database/list-saved-searches"},{"openapi":"post /database/saved-searches","title":"Create Saved Search","href":"/api-reference/endpoints/people-database/create-saved-search"},{"openapi":"get /database/saved-searches/{savedSearchId}","title":"Get Saved Search","href":"/api-reference/endpoints/people-database/get-saved-search"},{"openapi":"patch /database/saved-searches/{savedSearchId}","title":"Update Saved Search","href":"/api-reference/endpoints/people-database/update-saved-search"},{"openapi":"delete /database/saved-searches/{savedSearchId}","title":"Delete Saved Search","href":"/api-reference/endpoints/people-database/delete-saved-search"}]},{"group":"Contact sourcing","expanded":false,"pages":[{"openapi":"post /contact-sourcing","title":"Run Contact Sourcing","href":"/api-reference/endpoints/contact-sourcing/run-contact-sourcing"},{"openapi":"get /contact-sourcing","title":"Get Contact Sourcing Run","href":"/api-reference/endpoints/contact-sourcing/get-contact-sourcing-run"},{"openapi":"post /contact-sourcing/contacts","title":"Add a Sourced Contact","href":"/api-reference/endpoints/contact-sourcing/add-sourced-contact"}]},{"group":"Enrich","expanded":false,"pages":[{"title":"Enrich Data","openapi":"post /enrich","href":"/api-reference/endpoints/enrich/enrich-data"},{"openapi":"post /v2/enrichments/bulk","title":"Bulk Enrich Data","href":"/api-reference/endpoints/enrich/bulk-enrich-data"},{"openapi":"post /leads/{leadId}/enrich","title":"Enrich Lead","href":"/api-reference/endpoints/enrich/enrich-lead"},{"openapi":"get /enrich/{enrichId}","title":"Get Enrichment Result","href":"/api-reference/endpoints/enrich/get-enrichment-result"}]},{"group":"Enrichment Providers","expanded":false,"pages":[{"openapi":"get /v2/enrichments/providers","title":"List Enrichment Providers","href":"/api-reference/endpoints/enrichment-providers/list-enrichment-providers"},{"openapi":"put /v2/enrichments/providers/{providerId}/connection","title":"Connect Provider","href":"/api-reference/endpoints/enrichment-providers/connect-provider"},{"openapi":"delete /v2/enrichments/providers/{providerId}/connection","title":"Disconnect Provider","href":"/api-reference/endpoints/enrichment-providers/disconnect-provider"}]},{"group":"Enrichment Waterfalls","expanded":false,"pages":[{"openapi":"get /v2/enrichments/waterfalls","title":"List Enrichment Waterfalls","href":"/api-reference/endpoints/enrichment-waterfalls/list-enrichment-waterfalls"},{"openapi":"get /v2/enrichments/waterfalls/{waterfallId}","title":"Get Enrichment Waterfall","href":"/api-reference/endpoints/enrichment-waterfalls/get-enrichment-waterfall"},{"openapi":"patch /v2/enrichments/waterfalls/{waterfallId}","title":"Update Enrichment Waterfall","href":"/api-reference/endpoints/enrichment-waterfalls/update-enrichment-waterfall"},{"openapi":"put /v2/enrichments/waterfalls/{waterfallId}/reset","title":"Reset Enrichment Waterfall","href":"/api-reference/endpoints/enrichment-waterfalls/reset-enrichment-waterfall"}]},{"group":"lemwarm","expanded":false,"pages":[{"openapi":"post /lemwarm/{userMailboxId}/start","title":"Start lemwarm","href":"/api-reference/endpoints/lemwarm/start-lemwarm"},{"openapi":"post /lemwarm/{userMailboxId}/pause","title":"Pause lemwarm","href":"/api-reference/endpoints/lemwarm/pause-lemwarm"},{"openapi":"get /lemwarm/{userMailboxId}/settings","title":"Get lemwarm Settings","href":"/api-reference/endpoints/lemwarm/get-lemwarm-settings"},{"openapi":"patch /lemwarm/{userMailboxId}/settings","title":"Update lemwarm Settings","href":"/api-reference/endpoints/lemwarm/update-lemwarm-settings"},{"openapi":"get /lemwarm/errors","title":"Get warmup errors","href":"/api-reference/endpoints/lemwarm/get-warmup-errors"}]},{"group":"Self-recovery","expanded":false,"pages":[{"openapi":"get /self-recovery/config","title":"Get Self-recovery Config","href":"/api-reference/endpoints/self-recovery/get-config"},{"openapi":"patch /self-recovery/config","title":"Update Self-recovery Config","href":"/api-reference/endpoints/self-recovery/update-config"},{"openapi":"get /self-recovery/history","title":"List Self-recovery History","href":"/api-reference/endpoints/self-recovery/get-history"}]},{"group":"Signal Agents","expanded":false,"pages":[{"openapi":"get /watchlist","title":"List Signal Agents","href":"/api-reference/endpoints/watch-list/list-watch-lists"},{"openapi":"post /watchlist","title":"Create Signal Agent","href":"/api-reference/endpoints/watch-list/create-watch-list"},{"openapi":"patch /watchlist","title":"Update Signal Agent","href":"/api-reference/endpoints/watch-list/update-watch-list"},{"openapi":"post /watchlist/crm-lists","title":"Monitor CRM Lists with a Signal Agent","href":"/api-reference/endpoints/watch-list/associate-crm-lists"},{"openapi":"delete /watchlist","title":"Delete Signal Agent","href":"/api-reference/endpoints/watch-list/delete-watch-list"},{"openapi":"get /watchlist/history","title":"Get Signal Agent configuration history","href":"/api-reference/endpoints/watch-list/get-history"},{"openapi":"get /watchlist/signals","title":"Get Signal Agent signals","href":"/api-reference/endpoints/watch-list/get-signals"},{"openapi":"put /watchlist/signals","title":"Mark signals handled or ignored","href":"/api-reference/endpoints/watch-list/mark-signals"},{"openapi":"post /watchlist/{watchListId}/external-signals","title":"Push external signals","href":"/api-reference/endpoints/watch-list/push-external-signals"},{"openapi":"get /watchlist/library","title":"List available signal types","href":"/api-reference/endpoints/watch-list/get-library"},{"openapi":"get /watchlist/filters","title":"List allowed filters per signal type","href":"/api-reference/endpoints/watch-list/get-filters"},{"openapi":"get /watchlist/filter-values","title":"Autocomplete filter values","href":"/api-reference/endpoints/watch-list/get-filter-values"},{"openapi":"get /watchlist/linkedin-profile-views/members","title":"List LinkedIn profile views members","href":"/api-reference/endpoints/watch-list/get-linkedin-profile-views-members"}]},{"group":"Deliverability alerts","expanded":false,"pages":[{"openapi":"get /deliverability/alerts","title":"List Deliverability Alerts","href":"/api-reference/endpoints/deliverability-alerts/list-alerts"},{"openapi":"post /deliverability/alerts","title":"Create Deliverability Alert","href":"/api-reference/endpoints/deliverability-alerts/create-alert"},{"openapi":"get /deliverability/alerts/{alertId}","title":"Get Deliverability Alert","href":"/api-reference/endpoints/deliverability-alerts/get-alert"},{"openapi":"patch /deliverability/alerts/{alertId}","title":"Update Deliverability Alert","href":"/api-reference/endpoints/deliverability-alerts/update-alert"},{"openapi":"delete /deliverability/alerts/{alertId}","title":"Delete Deliverability Alert","href":"/api-reference/endpoints/deliverability-alerts/delete-alert"},{"openapi":"get /deliverability/incidents","title":"List Deliverability Incidents","href":"/api-reference/endpoints/deliverability-alerts/list-incidents"}]},{"group":"Sender picture","expanded":false,"pages":[{"openapi":"get /sender-picture/mailboxes","title":"Get Sender Picture Status","href":"/api-reference/endpoints/sender-picture/get-sender-picture-status"},{"openapi":"post /sender-picture/sync","title":"Sync Sender Picture","href":"/api-reference/endpoints/sender-picture/sync-sender-picture"}]},{"group":"Domains","expanded":false,"pages":[{"openapi":"post /domains-core/search","title":"Search Domains","href":"/api-reference/endpoints/domains/search-domains"},{"openapi":"post /domains-core/purchase","title":"Purchase Domain","href":"/api-reference/endpoints/domains/purchase-domain"},{"openapi":"get /domains-core/team-domains","title":"List Domains","href":"/api-reference/endpoints/domains/list-domains"},{"openapi":"post /domains-core/{domainId}/mailboxes","title":"Order Mailboxes","href":"/api-reference/endpoints/domains/order-mailboxes"},{"openapi":"get /domains-core/mailboxes","title":"List Domain Mailboxes","href":"/api-reference/endpoints/domains/list-domain-mailboxes"},{"openapi":"patch /domains-core/mailboxes/{mailboxId}","title":"Update Domain Mailbox","href":"/api-reference/endpoints/domains/update-domain-mailbox"}]},{"group":"Fields","expanded":false,"pages":[{"openapi":"get /fields","title":"List Fields","href":"/api-reference/endpoints/fields/list-fields"},{"openapi":"post /fields","title":"Create or Update Field","href":"/api-reference/endpoints/fields/create-field"},{"openapi":"delete /fields/{entity}/{name}","title":"Delete Field","href":"/api-reference/endpoints/fields/delete-field"}]}]},{"group":"Objects \u0026 Definitions","pages":[{"title":"Team","href":"/api-reference/objects-definitions/team"},{"title":null,"href":"/api-reference/objects-definitions/credits"},{"title":"User","href":"/api-reference/objects-definitions/user"},{"title":"Campaign","href":"/api-reference/objects-definitions/campaign"},{"title":"Campaign Settings","href":"/api-reference/objects-definitions/campaign-settings"},{"title":"Lead","href":"/api-reference/objects-definitions/lead"},{"title":"Activity","href":"/api-reference/objects-definitions/activity"},{"title":"Enrichment","href":"/api-reference/objects-definitions/enrich"},{"title":"Task","href":"/api-reference/objects-definitions/task"},{"title":"Inbox Conversation","href":"/api-reference/objects-definitions/inbox-conversation"},{"title":"Inbox Message","href":"/api-reference/objects-definitions/inbox-message"},{"title":"Contact","href":"/api-reference/objects-definitions/contact"},{"title":"Self-recovery config","href":"/api-reference/objects-definitions/self-recovery-config"},{"title":"Self-recovery case","href":"/api-reference/objects-definitions/self-recovery-case"},{"group":"People Database","expanded":false,"pages":[{"title":"Database","href":"/api-reference/objects-definitions/database"},{"title":"People","href":"/api-reference/objects-definitions/people-database"},{"title":"Company","href":"/api-reference/objects-definitions/company-database"},{"title":"Persona","href":"/api-reference/objects-definitions/persona"},{"title":"Saved search","href":"/api-reference/objects-definitions/saved-search"}]},{"title":"CRM Filter","href":"/api-reference/objects-definitions/crm-filter"},{"title":null,"href":"/api-reference/objects-definitions/company"},{"title":"Lemwarm Settings","href":"/api-reference/objects-definitions/lemwarm"},{"title":"Warmup Error","href":"/api-reference/objects-definitions/warmup-error"},{"title":"Campaign Status","href":"/api-reference/objects-definitions/campaign-status"},{"title":"Channel","href":"/api-reference/objects-definitions/channel"},{"title":"Sequence","href":"/api-reference/objects-definitions/sequence"},{"title":"Step","href":"/api-reference/objects-definitions/step"},{"title":"Message template","href":"/api-reference/objects-definitions/message-template"},{"title":"Snippet","href":"/api-reference/objects-definitions/snippet"},{"title":"Schedule","href":"/api-reference/objects-definitions/schedule"},{"title":"Label","href":"/api-reference/objects-definitions/label"},{"title":"Report","href":"/api-reference/objects-definitions/report"},{"title":"Webhook","href":"/api-reference/objects-definitions/webhook"},{"title":"Mailbox","href":"/api-reference/objects-definitions/mailbox"},{"title":"Domain","href":"/api-reference/objects-definitions/domain"},{"title":"Domain mailbox","href":"/api-reference/objects-definitions/domain-mailbox"},{"title":"Company Note","href":"/api-reference/objects-definitions/company-note"},{"title":"Contact Note","href":"/api-reference/objects-definitions/contact-note"},{"title":"CRM Log","href":"/api-reference/objects-definitions/crm-log"},{"title":"Signal Agents / Signal","href":"/api-reference/objects-definitions/signal"},{"title":"Signal Agents / Watch List","href":"/api-reference/objects-definitions/watch-list"},{"title":"Deliverability alert","href":"/api-reference/objects-definitions/deliverability-alert"},{"title":"Deliverability incident","href":"/api-reference/objects-definitions/deliverability-incident"},{"title":"Sender picture","href":"/api-reference/objects-definitions/sender-picture"}]}]},{"tab":"MCP Server","pages":[{"title":"MCP Server","href":"/mcp/setup"}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/cli/overview"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides"}]}]},"basePath":"","title":"Lemlist Developer Docs","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}