Create a webhook listener for one of your connected accounts. The delivery mode is determined by whether you provide a url:
With url — Custom mode: events are sent as POST requests to your URL
Without url — Hosted mode: events are available via SSE stream or polling
Monitoring starts as soon as the webhook is created. No need to call /start: it only resumes a webhook stopped with /stop.Cost. Creating a webhook is free. On a per-account plan, monitoring is included. On a credit plan, a monitored account costs ≈10 credits/day.
Check your subscription: all is not every event. It leaves out the opt-in events (message_read, message_reaction, message_edited, message_deleted, message_delivered, message_failed), and message_type defaults to inbound, so the messages the account sends are left out too. Event types added later will also be opt-in.To receive everything, set explicitly:
disconnection is always delivered, whatever the filter.
Header Parameters
string
required
Your API key
Body Parameters
string
The ID of the account to monitor. Must be an account you own (created via /v2/login). Send either account_id or account_ids.
array
Up to 100 account IDs: creates one webhook per account with the same settings, in one call. The response lists the created webhooks in data.webhooks and the accounts that could not be attached in data.failed; the others are still created. With enable_signature, all of them share the one secret returned.
string
The URL where events will be sent as POST requests. Must be a publicly accessible HTTPS endpoint.Omit this field to create a hosted webhook (SSE/polling).
array
default:"[\"all\"]"
List of event types to listen for. Defaults to ["all"]. Applies to custom mode only: hosted webhooks always receive every event type.Available event types: message_received, accepted_invitation, invitation_received, message_read (LinkedIn and WhatsApp read receipts, opt-in: not covered by all), message_reaction, message_edited and message_deleted (LinkedIn, opt-in), message_delivered and message_failed (WhatsApp delivery receipts, opt-in), all. For an email account, message_received covers new incoming emails and email_bounced (delivered via all) covers bounces — see Email events.
string
default:"inbound"
Direction filter for message events: inbound (messages received by the account), outbound (messages the account sends, through the API or typed by hand on LinkedIn) or all. Outbound messages carry event.direction: "outbound" and event.sender.is_self_sent: true.
boolean
default:"true"
Custom mode only. When true, a POST that times out or gets a 5xx/429 is retried with backoff (8 attempts over ~45 h) and every attempt is visible in the delivery log. Set false for fire-and-forget (failures are still logged). See Delivery & retries.
boolean
default:"false"
Custom mode only. When true, every outbound POST is signed with HMAC-SHA256 so you can verify it came from LinkUp. The response returns a secretonce — store it; it cannot be retrieved later. See Signature Verification.
Response
boolean
Whether the webhook was created successfully
object
Show Properties
string
Unique identifier for the webhook
string
The account this webhook is attached to
string
"hosted" or "custom" depending on whether url was provided
string
The webhook URL (custom mode only)
string
SSE stream endpoint (hosted mode only)
string
Stored-events polling endpoint (both modes) — the catch-up path
string
Delivery log endpoint (custom mode only)
boolean
Whether failed POSTs are retried (custom mode only)
array
Event types this webhook listens for
boolean
Whether the webhook is active
string
HMAC secret. Returned only when enable_signature: true and only at creation. Save it — there is no way to read it back later. Use /rotate-secret to generate a new one.
The webhook is created in an active and monitoring state — events start flowing immediately, no extra call required.
You can create multiple webhooks for the same account with different event filters. Billing is per-account (not per-webhook), so adding a second webhook to the same account doesn’t double the credit cost.
Stopping the last active webhook on an account (via /stop or DELETE) halts monitoring and stops the credit billing automatically. Other webhooks on the same account are unaffected.
For custom mode, the webhook URL must return a 200 status code to acknowledge receipt.
When accepted_invitation is in the events list, the API performs an initial sync of your connections to enable detection of new acceptances. Likewise, invitation_received stores a baseline of your pending invitations — the existing backlog is never notified, only invitations received after creation.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"LinkUp API","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/linkup/ZlfbWzmoiFddAPIP/logo/light.svg?fit=max\u0026auto=format\u0026n=ZlfbWzmoiFddAPIP\u0026q=85\u0026s=910520051bbdecf6c5ba291bc05e176c","dark":"https://mintcdn.com/linkup/ZlfbWzmoiFddAPIP/logo/dark.svg?fit=max\u0026auto=format\u0026n=ZlfbWzmoiFddAPIP\u0026q=85\u0026s=5ec6ea859b567d1cae384801ba8051eb"},"favicon":"https://mintcdn.com/linkup/ZlfbWzmoiFddAPIP/favicon.svg?fit=max\u0026auto=format\u0026n=ZlfbWzmoiFddAPIP\u0026q=85\u0026s=a9239e0f360c22cd2876d0186db14f72","api":{"playground":{"display":"interactive"},"mdx":{"server":"https://api.linkupapi.com"}},"search":{"prompt":"Search the docs..."},"contextual":{"options":["copy","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"linkup","hasAudioNarration":false,"actualSubdomain":"linkup","customDomains":["docs.linkupapi.com"],"gitSource":{"type":"github","owner":"titouanprx","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true},"entitlements":{},"buildId":"6af8670e8a96985090c51480","clientVersion":"0.0.4160","searchFilterCounts":[{"language":"default","tag":"Documentation","count":160},{"language":"default","tag":"LinkedIn Engagement API","count":37},{"language":"default","tag":"Profiles","count":19},{"language":"default","tag":"Data API","count":15},{"language":"default","tag":"Recruiting","count":14},{"language":"default","tag":"Network","count":13},{"language":"default","tag":"Messaging","count":12},{"language":"default","tag":"Content \u0026 Posts","count":11},{"language":"default","tag":"Content","count":11},{"language":"default","tag":"Accounts","count":9}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/v2/webhooks/create","slug":"/api-reference/v2/webhooks/create","pageMetadata":{"title":"Create Webhook","api":"POST /v2/webhooks","description":"Register a webhook to receive real-time events for an account","href":"/api-reference/v2/webhooks/create"},"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: \"Register a webhook to receive real-time events for an account\"\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];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,Note,ParamField,ResponseField,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Create a webhook listener for one of your connected accounts. The delivery mode is determined by whether you provide a `,_jsx(_components.code,{children:`url`}),`:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsxs(_components.strong,{children:[`With `,_jsx(_components.code,{children:`url`})]}),` — Custom mode: events are sent as `,_jsx(_components.code,{children:`POST`}),` requests to your URL`]}),`\n`,_jsxs(_components.li,{children:[_jsxs(_components.strong,{children:[`Without `,_jsx(_components.code,{children:`url`})]}),` — Hosted mode: events are available via `,_jsx(_components.a,{href:`/api-reference/v2/webhooks/stream`,children:`SSE stream`}),` or `,_jsx(_components.a,{href:`/api-reference/v2/webhooks/events`,children:`polling`})]}),`\n`]}),`\n`,_jsxs(Note,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Monitoring starts as soon as the webhook is created.`}),` No need to call `,_jsx(_components.a,{href:`/api-reference/v2/webhooks/start`,children:_jsx(_components.code,{children:`/start`})}),`: it only resumes a webhook stopped with `,_jsx(_components.a,{href:`/api-reference/v2/webhooks/stop`,children:_jsx(_components.code,{children:`/stop`})}),`.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Cost.`}),` Creating a webhook is free. On a per-account plan, monitoring is included. On a credit plan, a monitored account costs ≈10 credits/day.`]})]}),`\n`,_jsxs(Warning,{children:[_jsxs(_components.p,{children:[_jsxs(_components.strong,{children:[`Check your subscription: `,_jsx(_components.code,{children:`all`}),` is not every event.`]}),` It leaves out the opt-in events (`,_jsx(_components.code,{children:`message_read`}),`, `,_jsx(_components.code,{children:`message_reaction`}),`, `,_jsx(_components.code,{children:`message_edited`}),`, `,_jsx(_components.code,{children:`message_deleted`}),`, `,_jsx(_components.code,{children:`message_delivered`}),`, `,_jsx(_components.code,{children:`message_failed`}),`), and `,_jsx(_components.code,{children:`message_type`}),` defaults to `,_jsx(_components.code,{children:`inbound`}),`, so the messages the account sends are left out too. Event types added later will also be opt-in.`]}),_jsx(_components.p,{children:`To receive everything, set explicitly:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"events\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"all\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"message_read\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"message_reaction\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"message_edited\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"message_deleted\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"message_delivered\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"message_failed\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"all\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsxs(_components.p,{children:[_jsx(_components.code,{children:`disconnection`}),` is always delivered, whatever the filter.`]})]}),`\n`,_jsx(Heading,{level:`3`,id:`header-parameters`,children:`Header Parameters`}),`\n`,_jsx(ParamField,{header:`x-api-key`,type:`string`,required:true,id:`param-x-api-key`,children:_jsx(_components.p,{children:`Your API key`})}),`\n`,_jsx(Heading,{level:`3`,id:`body-parameters`,children:`Body Parameters`}),`\n`,_jsx(ParamField,{body:`account_id`,type:`string`,id:`param-account-id`,children:_jsxs(_components.p,{children:[`The ID of the account to monitor. Must be an account you own (created via `,_jsx(_components.code,{children:`/v2/login`}),`). Send either `,_jsx(_components.code,{children:`account_id`}),` or `,_jsx(_components.code,{children:`account_ids`}),`.`]})}),`\n`,_jsx(ParamField,{body:`account_ids`,type:`array`,id:`param-account-ids`,children:_jsxs(_components.p,{children:[`Up to 100 account IDs: creates one webhook per account with the same settings, in one call. The response lists the created webhooks in `,_jsx(_components.code,{children:`data.webhooks`}),` and the accounts that could not be attached in `,_jsx(_components.code,{children:`data.failed`}),`; the others are still created. With `,_jsx(_components.code,{children:`enable_signature`}),`, all of them share the one `,_jsx(_components.code,{children:`secret`}),` returned.`]})}),`\n`,_jsxs(ParamField,{body:`url`,type:`string`,id:`param-url`,children:[_jsxs(_components.p,{children:[`The URL where events will be sent as `,_jsx(_components.code,{children:`POST`}),` requests. Must be a publicly accessible HTTPS endpoint.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Omit this field`}),` to create a hosted webhook (SSE/polling).`]})]}),`\n`,_jsxs(ParamField,{body:`events`,type:`array`,default:`[\"all\"]`,id:`param-events`,children:[_jsxs(_components.p,{children:[`List of event types to listen for. Defaults to `,_jsx(_components.code,{children:`[\"all\"]`}),`. Applies to `,_jsx(_components.strong,{children:`custom mode`}),` only: hosted webhooks always receive every event type.`]}),_jsxs(_components.p,{children:[`Available event types: `,_jsx(_components.code,{children:`message_received`}),`, `,_jsx(_components.code,{children:`accepted_invitation`}),`, `,_jsx(_components.code,{children:`invitation_received`}),`, `,_jsx(_components.code,{children:`message_read`}),` (LinkedIn and WhatsApp read receipts, opt-in: not covered by `,_jsx(_components.code,{children:`all`}),`), `,_jsx(_components.code,{children:`message_reaction`}),`, `,_jsx(_components.code,{children:`message_edited`}),` and `,_jsx(_components.code,{children:`message_deleted`}),` (LinkedIn, opt-in), `,_jsx(_components.code,{children:`message_delivered`}),` and `,_jsx(_components.code,{children:`message_failed`}),` (WhatsApp delivery receipts, opt-in), `,_jsx(_components.code,{children:`all`}),`. For an `,_jsx(_components.strong,{children:`email`}),` account, `,_jsx(_components.code,{children:`message_received`}),` covers new incoming emails and `,_jsx(_components.code,{children:`email_bounced`}),` (delivered via `,_jsx(_components.code,{children:`all`}),`) covers bounces — see `,_jsx(_components.a,{href:`/api-reference/v2/webhooks/introduction#email-events`,children:`Email events`}),`.`]})]}),`\n`,_jsx(ParamField,{body:`message_type`,type:`string`,default:`inbound`,id:`param-message-type`,children:_jsxs(_components.p,{children:[`Direction filter for message events: `,_jsx(_components.code,{children:`inbound`}),` (messages received by the account), `,_jsx(_components.code,{children:`outbound`}),` (messages the account sends, through the API or typed by hand on LinkedIn) or `,_jsx(_components.code,{children:`all`}),`. Outbound messages carry `,_jsx(_components.code,{children:`event.direction: \"outbound\"`}),` and `,_jsx(_components.code,{children:`event.sender.is_self_sent: true`}),`.`]})}),`\n`,_jsx(ParamField,{body:`retry`,type:`boolean`,default:`true`,id:`param-retry`,children:_jsxs(_components.p,{children:[`Custom mode only. When `,_jsx(_components.code,{children:`true`}),`, a POST that times out or gets a `,_jsx(_components.code,{children:`5xx`}),`/`,_jsx(_components.code,{children:`429`}),` is retried with backoff (8 attempts over ~45 h) and every attempt is visible in the delivery log. Set `,_jsx(_components.code,{children:`false`}),` for fire-and-forget (failures are still logged). See `,_jsx(_components.a,{href:`/api-reference/v2/webhooks/introduction#delivery-retries-custom-mode`,children:`Delivery \u0026 retries`}),`.`]})}),`\n`,_jsx(ParamField,{body:`enable_signature`,type:`boolean`,default:`false`,id:`param-enable-signature`,children:_jsxs(_components.p,{children:[`Custom mode only. When `,_jsx(_components.code,{children:`true`}),`, every outbound POST is signed with HMAC-SHA256 so you can verify it came from LinkUp. The response returns a `,_jsx(_components.code,{children:`secret`}),` `,_jsx(_components.strong,{children:`once`}),` — store it; it cannot be retrieved later. See `,_jsx(_components.a,{href:`/api-reference/v2/webhooks/signature`,children:`Signature Verification`}),`.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success`,children:_jsx(_components.p,{children:`Whether the webhook was created successfully`})}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data`,children:_jsxs(Expandable,{title:`Properties`,children:[_jsx(ResponseField,{name:`webhook_id`,type:`string`,id:`param-webhook-id`,children:_jsx(_components.p,{children:`Unique identifier for the webhook`})}),_jsx(ResponseField,{name:`account_id`,type:`string`,id:`param-account-id-1`,children:_jsx(_components.p,{children:`The account this webhook is attached to`})}),_jsx(ResponseField,{name:`mode`,type:`string`,id:`param-mode`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`\"hosted\"`}),` or `,_jsx(_components.code,{children:`\"custom\"`}),` depending on whether `,_jsx(_components.code,{children:`url`}),` was provided`]})}),_jsx(ResponseField,{name:`url`,type:`string`,id:`param-url-1`,children:_jsx(_components.p,{children:`The webhook URL (custom mode only)`})}),_jsx(ResponseField,{name:`stream_url`,type:`string`,id:`param-stream-url`,children:_jsx(_components.p,{children:`SSE stream endpoint (hosted mode only)`})}),_jsx(ResponseField,{name:`events_url`,type:`string`,id:`param-events-url`,children:_jsx(_components.p,{children:`Stored-events polling endpoint (both modes) — the catch-up path`})}),_jsx(ResponseField,{name:`deliveries_url`,type:`string`,id:`param-deliveries-url`,children:_jsx(_components.p,{children:`Delivery log endpoint (custom mode only)`})}),_jsx(ResponseField,{name:`retry`,type:`boolean`,id:`param-retry-1`,children:_jsx(_components.p,{children:`Whether failed POSTs are retried (custom mode only)`})}),_jsx(ResponseField,{name:`events`,type:`array`,id:`param-events-1`,children:_jsx(_components.p,{children:`Event types this webhook listens for`})}),_jsx(ResponseField,{name:`is_active`,type:`boolean`,id:`param-is-active`,children:_jsx(_components.p,{children:`Whether the webhook is active`})}),_jsx(ResponseField,{name:`secret`,type:`string`,id:`param-secret`,children:_jsxs(_components.p,{children:[`HMAC secret. Returned `,_jsxs(_components.strong,{children:[`only when `,_jsx(_components.code,{children:`enable_signature: true`})]}),` and only at creation. Save it — there is no way to read it back later. Use `,_jsx(_components.a,{href:`/api-reference/v2/webhooks/signature`,children:_jsx(_components.code,{children:`/rotate-secret`})}),` to generate a new one.`]})})]})}),`\n`,`\n`,_jsx(Heading,{level:`3`,id:`notes`,children:`Notes`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`The webhook is created in an `,_jsx(_components.strong,{children:`active and monitoring`}),` state — events start flowing immediately, no extra call required.`]}),`\n`,_jsx(_components.li,{children:`You can create multiple webhooks for the same account with different event filters. Billing is per-account (not per-webhook), so adding a second webhook to the same account doesn’t double the credit cost.`}),`\n`,_jsxs(_components.li,{children:[`Stopping the `,_jsx(_components.strong,{children:`last`}),` active webhook on an account (via `,_jsx(_components.a,{href:`/api-reference/v2/webhooks/stop`,children:_jsx(_components.code,{children:`/stop`})}),` or `,_jsx(_components.a,{href:`/api-reference/v2/webhooks/delete`,children:_jsx(_components.code,{children:`DELETE`})}),`) halts monitoring and stops the credit billing automatically. Other webhooks on the same account are unaffected.`]}),`\n`,_jsxs(_components.li,{children:[`For custom mode, the webhook URL must return a `,_jsx(_components.code,{children:`200`}),` status code to acknowledge receipt.`]}),`\n`,_jsxs(_components.li,{children:[`When `,_jsx(_components.code,{children:`accepted_invitation`}),` is in the events list, the API performs an initial sync of your connections to enable detection of new acceptances. Likewise, `,_jsx(_components.code,{children:`invitation_received`}),` stores a baseline of your pending invitations — the existing backlog is never notified, only invitations received after creation.`]}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{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":{"config":{},"pageMetadata":{"title":"Create Webhook","api":"POST /v2/webhooks","description":"Register a webhook to receive real-time events for an account","href":"/api-reference/v2/webhooks/create"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,Note,ParamField,ResponseExample,ResponseField,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Create a webhook listener for one of your connected accounts. The delivery mode is determined by whether you provide a `,_jsx(_components.code,{children:`url`}),`:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsxs(_components.strong,{children:[`With `,_jsx(_components.code,{children:`url`})]}),` — Custom mode: events are sent as `,_jsx(_components.code,{children:`POST`}),` requests to your URL`]}),`\n`,_jsxs(_components.li,{children:[_jsxs(_components.strong,{children:[`Without `,_jsx(_components.code,{children:`url`})]}),` — Hosted mode: events are available via `,_jsx(_components.a,{href:`/api-reference/v2/webhooks/stream`,children:`SSE stream`}),` or `,_jsx(_components.a,{href:`/api-reference/v2/webhooks/events`,children:`polling`})]}),`\n`]}),`\n`,_jsxs(Note,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Monitoring starts as soon as the webhook is created.`}),` No need to call `,_jsx(_components.a,{href:`/api-reference/v2/webhooks/start`,children:_jsx(_components.code,{children:`/start`})}),`: it only resumes a webhook stopped with `,_jsx(_components.a,{href:`/api-reference/v2/webhooks/stop`,children:_jsx(_components.code,{children:`/stop`})}),`.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Cost.`}),` Creating a webhook is free. On a per-account plan, monitoring is included. On a credit plan, a monitored account costs ≈10 credits/day.`]})]}),`\n`,_jsxs(Warning,{children:[_jsxs(_components.p,{children:[_jsxs(_components.strong,{children:[`Check your subscription: `,_jsx(_components.code,{children:`all`}),` is not every event.`]}),` It leaves out the opt-in events (`,_jsx(_components.code,{children:`message_read`}),`, `,_jsx(_components.code,{children:`message_reaction`}),`, `,_jsx(_components.code,{children:`message_edited`}),`, `,_jsx(_components.code,{children:`message_deleted`}),`, `,_jsx(_components.code,{children:`message_delivered`}),`, `,_jsx(_components.code,{children:`message_failed`}),`), and `,_jsx(_components.code,{children:`message_type`}),` defaults to `,_jsx(_components.code,{children:`inbound`}),`, so the messages the account sends are left out too. Event types added later will also be opt-in.`]}),_jsx(_components.p,{children:`To receive everything, set explicitly:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"events\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"all\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"message_read\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"message_reaction\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"message_edited\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"message_deleted\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"message_delivered\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"message_failed\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"all\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsxs(_components.p,{children:[_jsx(_components.code,{children:`disconnection`}),` is always delivered, whatever the filter.`]})]}),`\n`,_jsx(Heading,{level:`3`,id:`header-parameters`,children:`Header Parameters`}),`\n`,_jsx(ParamField,{header:`x-api-key`,type:`string`,required:true,id:`param-x-api-key`,children:_jsx(_components.p,{children:`Your API key`})}),`\n`,_jsx(Heading,{level:`3`,id:`body-parameters`,children:`Body Parameters`}),`\n`,_jsx(ParamField,{body:`account_id`,type:`string`,id:`param-account-id`,children:_jsxs(_components.p,{children:[`The ID of the account to monitor. Must be an account you own (created via `,_jsx(_components.code,{children:`/v2/login`}),`). Send either `,_jsx(_components.code,{children:`account_id`}),` or `,_jsx(_components.code,{children:`account_ids`}),`.`]})}),`\n`,_jsx(ParamField,{body:`account_ids`,type:`array`,id:`param-account-ids`,children:_jsxs(_components.p,{children:[`Up to 100 account IDs: creates one webhook per account with the same settings, in one call. The response lists the created webhooks in `,_jsx(_components.code,{children:`data.webhooks`}),` and the accounts that could not be attached in `,_jsx(_components.code,{children:`data.failed`}),`; the others are still created. With `,_jsx(_components.code,{children:`enable_signature`}),`, all of them share the one `,_jsx(_components.code,{children:`secret`}),` returned.`]})}),`\n`,_jsxs(ParamField,{body:`url`,type:`string`,id:`param-url`,children:[_jsxs(_components.p,{children:[`The URL where events will be sent as `,_jsx(_components.code,{children:`POST`}),` requests. Must be a publicly accessible HTTPS endpoint.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Omit this field`}),` to create a hosted webhook (SSE/polling).`]})]}),`\n`,_jsxs(ParamField,{body:`events`,type:`array`,default:`[\"all\"]`,id:`param-events`,children:[_jsxs(_components.p,{children:[`List of event types to listen for. Defaults to `,_jsx(_components.code,{children:`[\"all\"]`}),`. Applies to `,_jsx(_components.strong,{children:`custom mode`}),` only: hosted webhooks always receive every event type.`]}),_jsxs(_components.p,{children:[`Available event types: `,_jsx(_components.code,{children:`message_received`}),`, `,_jsx(_components.code,{children:`accepted_invitation`}),`, `,_jsx(_components.code,{children:`invitation_received`}),`, `,_jsx(_components.code,{children:`message_read`}),` (LinkedIn and WhatsApp read receipts, opt-in: not covered by `,_jsx(_components.code,{children:`all`}),`), `,_jsx(_components.code,{children:`message_reaction`}),`, `,_jsx(_components.code,{children:`message_edited`}),` and `,_jsx(_components.code,{children:`message_deleted`}),` (LinkedIn, opt-in), `,_jsx(_components.code,{children:`message_delivered`}),` and `,_jsx(_components.code,{children:`message_failed`}),` (WhatsApp delivery receipts, opt-in), `,_jsx(_components.code,{children:`all`}),`. For an `,_jsx(_components.strong,{children:`email`}),` account, `,_jsx(_components.code,{children:`message_received`}),` covers new incoming emails and `,_jsx(_components.code,{children:`email_bounced`}),` (delivered via `,_jsx(_components.code,{children:`all`}),`) covers bounces — see `,_jsx(_components.a,{href:`/api-reference/v2/webhooks/introduction#email-events`,children:`Email events`}),`.`]})]}),`\n`,_jsx(ParamField,{body:`message_type`,type:`string`,default:`inbound`,id:`param-message-type`,children:_jsxs(_components.p,{children:[`Direction filter for message events: `,_jsx(_components.code,{children:`inbound`}),` (messages received by the account), `,_jsx(_components.code,{children:`outbound`}),` (messages the account sends, through the API or typed by hand on LinkedIn) or `,_jsx(_components.code,{children:`all`}),`. Outbound messages carry `,_jsx(_components.code,{children:`event.direction: \"outbound\"`}),` and `,_jsx(_components.code,{children:`event.sender.is_self_sent: true`}),`.`]})}),`\n`,_jsx(ParamField,{body:`retry`,type:`boolean`,default:`true`,id:`param-retry`,children:_jsxs(_components.p,{children:[`Custom mode only. When `,_jsx(_components.code,{children:`true`}),`, a POST that times out or gets a `,_jsx(_components.code,{children:`5xx`}),`/`,_jsx(_components.code,{children:`429`}),` is retried with backoff (8 attempts over ~45 h) and every attempt is visible in the delivery log. Set `,_jsx(_components.code,{children:`false`}),` for fire-and-forget (failures are still logged). See `,_jsx(_components.a,{href:`/api-reference/v2/webhooks/introduction#delivery-retries-custom-mode`,children:`Delivery \u0026 retries`}),`.`]})}),`\n`,_jsx(ParamField,{body:`enable_signature`,type:`boolean`,default:`false`,id:`param-enable-signature`,children:_jsxs(_components.p,{children:[`Custom mode only. When `,_jsx(_components.code,{children:`true`}),`, every outbound POST is signed with HMAC-SHA256 so you can verify it came from LinkUp. The response returns a `,_jsx(_components.code,{children:`secret`}),` `,_jsx(_components.strong,{children:`once`}),` — store it; it cannot be retrieved later. See `,_jsx(_components.a,{href:`/api-reference/v2/webhooks/signature`,children:`Signature Verification`}),`.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success`,children:_jsx(_components.p,{children:`Whether the webhook was created successfully`})}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data`,children:_jsxs(Expandable,{title:`Properties`,children:[_jsx(ResponseField,{name:`webhook_id`,type:`string`,id:`param-webhook-id`,children:_jsx(_components.p,{children:`Unique identifier for the webhook`})}),_jsx(ResponseField,{name:`account_id`,type:`string`,id:`param-account-id-1`,children:_jsx(_components.p,{children:`The account this webhook is attached to`})}),_jsx(ResponseField,{name:`mode`,type:`string`,id:`param-mode`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`\"hosted\"`}),` or `,_jsx(_components.code,{children:`\"custom\"`}),` depending on whether `,_jsx(_components.code,{children:`url`}),` was provided`]})}),_jsx(ResponseField,{name:`url`,type:`string`,id:`param-url-1`,children:_jsx(_components.p,{children:`The webhook URL (custom mode only)`})}),_jsx(ResponseField,{name:`stream_url`,type:`string`,id:`param-stream-url`,children:_jsx(_components.p,{children:`SSE stream endpoint (hosted mode only)`})}),_jsx(ResponseField,{name:`events_url`,type:`string`,id:`param-events-url`,children:_jsx(_components.p,{children:`Stored-events polling endpoint (both modes) — the catch-up path`})}),_jsx(ResponseField,{name:`deliveries_url`,type:`string`,id:`param-deliveries-url`,children:_jsx(_components.p,{children:`Delivery log endpoint (custom mode only)`})}),_jsx(ResponseField,{name:`retry`,type:`boolean`,id:`param-retry-1`,children:_jsx(_components.p,{children:`Whether failed POSTs are retried (custom mode only)`})}),_jsx(ResponseField,{name:`events`,type:`array`,id:`param-events-1`,children:_jsx(_components.p,{children:`Event types this webhook listens for`})}),_jsx(ResponseField,{name:`is_active`,type:`boolean`,id:`param-is-active`,children:_jsx(_components.p,{children:`Whether the webhook is active`})}),_jsx(ResponseField,{name:`secret`,type:`string`,id:`param-secret`,children:_jsxs(_components.p,{children:[`HMAC secret. Returned `,_jsxs(_components.strong,{children:[`only when `,_jsx(_components.code,{children:`enable_signature: true`})]}),` and only at creation. Save it — there is no way to read it back later. Use `,_jsx(_components.a,{href:`/api-reference/v2/webhooks/signature`,children:_jsx(_components.code,{children:`/rotate-secret`})}),` to generate a new one.`]})})]})}),`\n`,_jsxs(ResponseExample,{children:[_jsx(CodeBlock,{filename:`Hosted Mode (no URL)`,numberOfLines:`17`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`17`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"webhook_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"6789abcdef0123456789abcd\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"account_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"69c127c37cae0494dd827286\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"mode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"hosted\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"stream_url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/v2/webhooks/6789abcdef0123456789abcd/stream\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"events_url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/v2/webhooks/6789abcdef0123456789abcd/events\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"events\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"accepted_invitation\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"message_received\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"is_active\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"metadata\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"action\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"create_webhook\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"credits_consumed\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"timestamp\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2025-01-15T10:30:00.000000\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Custom Mode (with URL)`,numberOfLines:`16`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`16`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"webhook_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"6789abcdef0123456789abcd\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"account_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"69c127c37cae0494dd827286\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"mode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"custom\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://your-server.com/webhook\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"events\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"all\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"is_active\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"metadata\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"action\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"create_webhook\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"credits_consumed\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"timestamp\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2025-01-15T10:30:00.000000\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Several accounts (account_ids)`,numberOfLines:`27`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`27`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"webhooks\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"webhook_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"6789abcdef0123456789abcd\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"account_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"69c127c37cae0494dd827286\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"mode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"custom\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://your-server.com/webhook\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"events\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"all\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"is_active\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"failed\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"account_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"69c127c37cae0494dd8272ff\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"INVALID_ACCOUNT\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Account not found\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"count\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"metadata\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"action\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"create_webhook\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"credits_consumed\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"timestamp\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2025-01-15T10:30:00.000000\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Error — Account Not Found`,numberOfLines:`12`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`12`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"INVALID_ACCOUNT\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Account not found\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"metadata\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"action\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"create_webhook\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"credits_consumed\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"timestamp\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2025-01-15T10:30:00.000000\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]}),`\n`,_jsx(Heading,{level:`3`,id:`notes`,children:`Notes`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`The webhook is created in an `,_jsx(_components.strong,{children:`active and monitoring`}),` state — events start flowing immediately, no extra call required.`]}),`\n`,_jsx(_components.li,{children:`You can create multiple webhooks for the same account with different event filters. Billing is per-account (not per-webhook), so adding a second webhook to the same account doesn’t double the credit cost.`}),`\n`,_jsxs(_components.li,{children:[`Stopping the `,_jsx(_components.strong,{children:`last`}),` active webhook on an account (via `,_jsx(_components.a,{href:`/api-reference/v2/webhooks/stop`,children:_jsx(_components.code,{children:`/stop`})}),` or `,_jsx(_components.a,{href:`/api-reference/v2/webhooks/delete`,children:_jsx(_components.code,{children:`DELETE`})}),`) halts monitoring and stops the credit billing automatically. Other webhooks on the same account are unaffected.`]}),`\n`,_jsxs(_components.li,{children:[`For custom mode, the webhook URL must return a `,_jsx(_components.code,{children:`200`}),` status code to acknowledge receipt.`]}),`\n`,_jsxs(_components.li,{children:[`When `,_jsx(_components.code,{children:`accepted_invitation`}),` is in the events list, the API performs an initial sync of your connections to enable detection of new acceptances. Likewise, `,_jsx(_components.code,{children:`invitation_received`}),` stores a baseline of your pending invitations — the existing backlog is never notified, only invitations received after creation.`]}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{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":{"config":{},"pageMetadata":{"title":"Create Webhook","api":"POST /v2/webhooks","description":"Register a webhook to receive real-time events for an account","href":"/api-reference/v2/webhooks/create"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Header Parameters","slug":"header-parameters","depth":3,"children":[]},{"title":"Body Parameters","slug":"body-parameters","depth":3,"children":[]},{"title":"Response","slug":"response","depth":3,"children":[]},{"title":"Notes","slug":"notes","depth":3,"children":[]}],"codeExamples":{"response":{"type":"ResponseExample","children":[{"filename":"Hosted Mode (no URL)","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"17\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"success\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">true\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"data\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"webhook_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"6789abcdef0123456789abcd\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"account_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"69c127c37cae0494dd827286\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"mode\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"hosted\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"stream_url\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"/v2/webhooks/6789abcdef0123456789abcd/stream\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"events_url\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"/v2/webhooks/6789abcdef0123456789abcd/events\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"events\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"accepted_invitation\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"message_received\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"is_active\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">true\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"metadata\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"action\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"create_webhook\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"credits_consumed\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">0\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"timestamp\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2025-01-15T10:30:00.000000\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"Custom Mode (with URL)","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"16\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"success\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">true\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"data\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"webhook_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"6789abcdef0123456789abcd\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"account_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"69c127c37cae0494dd827286\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"mode\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"custom\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"url\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"https://your-server.com/webhook\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"events\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"all\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"is_active\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">true\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"metadata\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"action\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"create_webhook\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"credits_consumed\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">0\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"timestamp\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2025-01-15T10:30:00.000000\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"Several accounts (account_ids)","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"27\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"success\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">true\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"data\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"webhooks\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"webhook_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"6789abcdef0123456789abcd\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"account_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"69c127c37cae0494dd827286\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"mode\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"custom\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"url\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"https://your-server.com/webhook\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"events\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"all\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"is_active\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">true\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"failed\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"account_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"69c127c37cae0494dd8272ff\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"error\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: { \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"code\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"INVALID_ACCOUNT\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Account not found\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"count\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">1\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"metadata\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"action\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"create_webhook\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"credits_consumed\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">0\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"timestamp\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2025-01-15T10:30:00.000000\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"Error — Account Not Found","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"12\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"success\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">false\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"error\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"code\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"INVALID_ACCOUNT\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Account not found\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"metadata\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"action\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"create_webhook\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"credits_consumed\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">0\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"timestamp\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2025-01-15T10:30:00.000000\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Create Webhook","path":"/v2/webhooks","servers":[{"url":"https://api.linkupapi.com"}],"method":"post","request":{"security":[],"parameters":{"query":{},"header":{"x-api-key":{"schema":[{"type":"string","description":"Your API key","required":true}]}},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"account_id":[{"type":"string","description":"The ID of the account to monitor. Must be an account you own (created via `/v2/login` ). Send either `account_id` or `account_ids` ."}],"account_ids":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"Up to 100 account IDs: creates one webhook per account with the same settings, in one call. The response lists the created webhooks in `data.webhooks` and the accounts that could not be attached in `data.failed` ; the others are still created. With `enable_signature` , all of them share the one `secret` returned."}],"url":[{"type":"string","description":"The URL where events will be sent as `POST` requests. Must be a publicly accessible HTTPS endpoint. Omit this field to create a hosted webhook (SSE/polling)."}],"events":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"List of event types to listen for. Defaults to `[\"all\"]` . Applies to custom mode only: hosted webhooks always receive every event type. Available event types: `message_received` , `accepted_invitation` , `invitation_received` , `message_read` (LinkedIn and WhatsApp read receipts, opt-in: not covered by `all` ), `message_reaction` , `message_edited` and `message_deleted` (LinkedIn, opt-in), `message_delivered` and `message_failed` (WhatsApp delivery receipts, opt-in), `all` . For an email account, `message_received` covers new incoming emails and `email_bounced` (delivered via `all` ) covers bounces — see Email events ."}],"message_type":[{"type":"string","description":"Direction filter for message events: `inbound` (messages received by the account), `outbound` (messages the account sends, through the API or typed by hand on LinkedIn) or `all` . Outbound messages carry `event.direction: \"outbound\"` and `event.sender.is_self_sent: true` ."}],"retry":[{"type":"boolean","description":"Custom mode only. When `true` , a POST that times out or gets a `5xx` / `429` is retried with backoff (8 attempts over ~45 h) and every attempt is visible in the delivery log. Set `false` for fire-and-forget (failures are still logged). See Delivery \u0026 retries ."}],"enable_signature":[{"type":"boolean","description":"Custom mode only. When `true` , every outbound POST is signed with HMAC-SHA256 so you can verify it came from LinkUp. The response returns a `secret` once — store it; it cannot be retrieved later. See Signature Verification ."}]}}],"examples":{"example":{"value":{"account_id":"\u003cstring>","account_ids":[{}],"url":"\u003cstring>","events":[{}],"message_type":"\u003cstring>","retry":true,"enable_signature":true}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"success":[{"type":"boolean","description":"Whether the webhook was created successfully"}],"data":[{"type":"object","properties":{"webhook_id":[{"type":"string","description":"Unique identifier for the webhook"}],"account_id":[{"type":"string","description":"The account this webhook is attached to"}],"mode":[{"type":"string","description":"`\"hosted\"` or `\"custom\"` depending on whether `url` was provided"}],"url":[{"type":"string","description":"The webhook URL (custom mode only)"}],"stream_url":[{"type":"string","description":"SSE stream endpoint (hosted mode only)"}],"events_url":[{"type":"string","description":"Stored-events polling endpoint (both modes) — the catch-up path"}],"deliveries_url":[{"type":"string","description":"Delivery log endpoint (custom mode only)"}],"retry":[{"type":"boolean","description":"Whether failed POSTs are retried (custom mode only)"}],"events":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"Event types this webhook listens for"}],"is_active":[{"type":"boolean","description":"Whether the webhook is active"}],"secret":[{"type":"string","description":"HMAC secret. Returned only when `enable_signature: true` and only at creation. Save it — there is no way to read it back later. Use `/rotate-secret` to generate a new one."}]}}]}}],"examples":{"example":{"value":{"success":true,"data":{"webhook_id":"\u003cstring>","account_id":"\u003cstring>","mode":"\u003cstring>","url":"\u003cstring>","stream_url":"\u003cstring>","events_url":"\u003cstring>","deliveries_url":"\u003cstring>","retry":true,"events":[{}],"is_active":true,"secret":"\u003cstring>"}}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"linkup","siteName":"LinkUp API","title":"Create Webhook - LinkUp API","navMaps":{"firstHrefInVersion":{"v2.0":{"href":"/api-reference/v2/webhooks/create","matchLevel":0},"v1.5":{"href":"/api-reference/introduction","matchLevel":4},"v1.0":{"href":"/api-reference/introduction","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-10-25T14:48:13.661Z","originalFileLocation":"api-reference/v2/webhooks/create.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=\"Register a webhook to receive real-time events for an account\">\u003cmeta data-mint-head name=\"application-name\" content=\"LinkUp API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/linkup/Pwp8bAx04X-d5qDo/_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/linkup/Pwp8bAx04X-d5qDo/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/linkup/Pwp8bAx04X-d5qDo/_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/linkup/Pwp8bAx04X-d5qDo/_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/linkup/Pwp8bAx04X-d5qDo/_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/linkup/Pwp8bAx04X-d5qDo/_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/linkup/Pwp8bAx04X-d5qDo/_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/linkup/Pwp8bAx04X-d5qDo/_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/linkup/Pwp8bAx04X-d5qDo/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Webhook - LinkUp API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Register a webhook to receive real-time events for an account\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"LinkUp API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.linkupapi.com/api-reference/v2/webhooks/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://linkup.mintlify.site/_mintlify/api/og/v2?division=Webhooks+%28Real-Time%29\u0026amp;title=Create+Webhook\u0026amp;description=Register+a+webhook+to+receive+real-time+events+for+an+account\u0026amp;theme=b0aaf15cbe23d1d94ca6fd79\u0026amp;signature=332ec09d53c034d5b2dfc40f76063dd7db0f45cb0c8d00f2588cc5660d3f78f5\">\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=\"Create Webhook - LinkUp API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Register a webhook to receive real-time events for an account\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://linkup.mintlify.site/_mintlify/api/og/v2?division=Webhooks+%28Real-Time%29\u0026amp;title=Create+Webhook\u0026amp;description=Register+a+webhook+to+receive+real-time+events+for+an+account\u0026amp;theme=b0aaf15cbe23d1d94ca6fd79\u0026amp;signature=332ec09d53c034d5b2dfc40f76063dd7db0f45cb0c8d00f2588cc5660d3f78f5\">\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/linkup/Pwp8bAx04X-d5qDo/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"LinkUp API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.linkupapi.com/api-reference/v2/webhooks/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v2/webhooks/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.linkupapi.com/#organization\",\"name\":\"LinkUp API\",\"url\":\"https://docs.linkupapi.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/linkup/ZlfbWzmoiFddAPIP/logo/light.svg?fit=max\u0026auto=format\u0026n=ZlfbWzmoiFddAPIP\u0026q=85\u0026s=910520051bbdecf6c5ba291bc05e176c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.linkupapi.com#website\",\"name\":\"LinkUp API\",\"url\":\"https://docs.linkupapi.com\",\"publisher\":{\"@id\":\"https://docs.linkupapi.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.linkupapi.com/api-reference/v2/webhooks/create#webpage\",\"url\":\"https://docs.linkupapi.com/api-reference/v2/webhooks/create\",\"name\":\"Create Webhook\",\"description\":\"Register a webhook to receive real-time events for an account\",\"dateModified\":\"2026-10-25T14:48:13.661Z\",\"isPartOf\":{\"@id\":\"https://docs.linkupapi.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.linkupapi.com/api-reference/v2/webhooks/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.linkupapi.com/api-reference/v2/webhooks/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Webhooks (Real-Time)\",\"item\":\"https://docs.linkupapi.com/api-reference/v2/webhooks/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Webhook\",\"item\":\"https://docs.linkupapi.com/api-reference/v2/webhooks/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.linkupapi.com/api-reference/v2/webhooks/create#apireference\",\"headline\":\"Create Webhook\",\"name\":\"Create Webhook\",\"description\":\"Register a webhook to receive real-time events for an account\",\"url\":\"https://docs.linkupapi.com/api-reference/v2/webhooks/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.linkupapi.com/api-reference/v2/webhooks/create#webpage\"},\"dateModified\":\"2026-10-25T14:48:13.661Z\",\"publisher\":{\"@id\":\"https://docs.linkupapi.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.linkupapi.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"LinkUp API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"LinkUp API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/v2/webhooks/create.md","siteName":"LinkUp API","nav":{"global":null,"versions":[{"version":"v2.0","default":true,"tag":"Latest","tabs":[{"tab":"Documentation","icon":"book","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/api-reference/v2/introduction"},{"title":"MCP Setup","href":"/api-reference/v2/mcp-setup"},{"title":"Platform Best Practices","href":"/api-reference/v2/best-practices"},{"title":"Migration from V1 to V2","href":"/api-reference/v2/migration"},{"title":"Error Codes","href":"/api-reference/v2/error-codes"}]},{"group":"Accounts","pages":[{"title":"Connect Account","api":"POST /v2/login","href":"/api-reference/v2/accounts/login"},{"title":"Verify Checkpoint (2FA)","api":"POST /v2/checkpoint","href":"/api-reference/v2/accounts/checkpoint"},{"title":"Hosted Connection Link","api":"POST /v2/accounts/connect-link","href":"/api-reference/v2/accounts/connect-link"},{"title":"Autoconfig Provider","api":"GET /v2/email/autoconfig","href":"/api-reference/v2/email/autoconfig"},{"title":"List Accounts","api":"GET /v2/accounts","href":"/api-reference/v2/accounts/list-accounts"},{"title":"Get Account Details","api":"GET /v2/accounts/{account_id}","href":"/api-reference/v2/accounts/get-account"},{"title":"Set Proxy Country","api":"POST /v2/accounts/{account_id}/country","href":"/api-reference/v2/accounts/set-country"},{"title":"Sync Inbox","api":"POST /v2/accounts/{account_id}/sync","href":"/api-reference/v2/accounts/sync-inbox"},{"title":"Delete Account","api":"DELETE /v2/accounts/{account_id}","href":"/api-reference/v2/accounts/delete-account"}]},{"group":"Profiles","pages":[{"title":"Get My Profile","api":"POST /v2/profiles","href":"/api-reference/v2/profiles/get-me"},{"title":"Update Profile","api":"POST /v2/profiles","href":"/api-reference/v2/profiles/update-profile"},{"title":"Get Profile Info","api":"POST /v2/profiles","href":"/api-reference/v2/profiles/get-profile"},{"title":"Get Contact Info","api":"POST /v2/profiles","href":"/api-reference/v2/profiles/get-contact"},{"title":"Visit Profile","api":"POST /v2/profiles","href":"/api-reference/v2/profiles/visit"},{"title":"Search People","api":"POST /v2/profiles","href":"/api-reference/v2/profiles/search-people"},{"title":"Search People Nav","sidebarTitle":"Search People Nav","api":"POST /v2/profiles","href":"/api-reference/v2/profiles/search-people-nav"},{"title":"Search Companies Nav","sidebarTitle":"Search Companies Nav","api":"POST /v2/profiles","href":"/api-reference/v2/profiles/search-companies-nav"},{"title":"Search People Recruiter","sidebarTitle":"Search People Recruiter","api":"POST /v2/profiles","href":"/api-reference/v2/profiles/search-people-recruiter"},{"title":"Check InMail","sidebarTitle":"Check InMail","api":"POST /v2/profiles","href":"/api-reference/v2/profiles/check-inmail"},{"title":"Check InMail Seat","sidebarTitle":"Check InMail Seat","api":"POST /v2/profiles","href":"/api-reference/v2/profiles/check-inmail-seat"},{"title":"Unlock Profile","api":"POST /v2/profiles","href":"/api-reference/v2/profiles/unlock"},{"title":"Typeahead (Filter Suggestions)","api":"POST /v2/typeahead","href":"/api-reference/v2/profiles/typeahead"},{"title":"Search Companies","api":"POST /v2/profiles","href":"/api-reference/v2/profiles/search-companies"},{"title":"Get Company Info","api":"POST /v2/profiles","href":"/api-reference/v2/profiles/get-company"},{"title":"Get Profile Viewers","api":"POST /v2/profiles","href":"/api-reference/v2/profiles/get-viewers"},{"title":"Get Profile Reactions","api":"POST /v2/profiles","href":"/api-reference/v2/profiles/get-reactions"},{"title":"Get Profile Comments","api":"POST /v2/profiles","href":"/api-reference/v2/profiles/get-comments"},{"title":"Get Profile Posts","api":"POST /v2/profiles","href":"/api-reference/v2/profiles/get-posts"}]},{"group":"Messaging","pages":[{"title":"Send Message or Email","api":"POST /v2/messages","href":"/api-reference/v2/messages/send"},{"title":"List Inbox","api":"POST /v2/messages","href":"/api-reference/v2/messages/list-inbox"},{"title":"Get Conversation","api":"POST /v2/messages","href":"/api-reference/v2/messages/get-conversation"},{"title":"Download Attachment","api":"GET /v2/messages/attachment","href":"/api-reference/v2/messages/download-attachment"},{"title":"Balance","api":"POST /v2/balance","href":"/api-reference/v2/messages/balance"},{"title":"Check Numbers","api":"POST /v2/messages","href":"/api-reference/v2/messages/check-numbers"},{"title":"Manage LinkedIn Messaging","href":"/api-reference/v2/messages/build-inbox"},{"title":"Manage Email Messaging","href":"/api-reference/v2/messages/manage-emails"},{"title":"Manage WhatsApp Messaging","href":"/api-reference/v2/messages/manage-whatsapp"}]},{"group":"Network","pages":[{"title":"Send Connection Request","api":"POST /v2/network","href":"/api-reference/v2/network/invite"},{"title":"Accept Invitation","api":"POST /v2/network","href":"/api-reference/v2/network/accept"},{"title":"Decline Invitation","api":"POST /v2/network","href":"/api-reference/v2/network/decline"},{"title":"List Connections","api":"POST /v2/network","href":"/api-reference/v2/network/list-connections"},{"title":"List Invitations","api":"POST /v2/network","href":"/api-reference/v2/network/list-invitations"},{"title":"List Sent Invitations","api":"POST /v2/network","href":"/api-reference/v2/network/list-sent"},{"title":"List Followers","api":"POST /v2/network","href":"/api-reference/v2/network/list-followers"},{"title":"Withdraw Invitation","api":"POST /v2/network","href":"/api-reference/v2/network/withdraw"},{"title":"Check Invitation Status","api":"POST /v2/network","href":"/api-reference/v2/network/check-invitation"},{"title":"Get Network Recommendations","api":"POST /v2/network","href":"/api-reference/v2/network/recommendations"},{"title":"Follow / Unfollow","api":"POST /v2/network","href":"/api-reference/v2/network/follow"},{"title":"Events","api":"POST /v2/network","href":"/api-reference/v2/network/events"},{"title":"Get Group Members","api":"POST /v2/network","href":"/api-reference/v2/network/group-members"}]},{"group":"Content","pages":[{"title":"Create Post","api":"POST /v2/content","href":"/api-reference/v2/content/create"},{"title":"Create Company Post","api":"POST /v2/content","href":"/api-reference/v2/content/create-company"},{"title":"Get Post","api":"POST /v2/content","href":"/api-reference/v2/content/get"},{"title":"Search Posts","api":"POST /v2/content","href":"/api-reference/v2/content/search"},{"title":"Get Feed","api":"POST /v2/content","href":"/api-reference/v2/content/get-feed"},{"title":"React to Post","api":"POST /v2/content","href":"/api-reference/v2/content/react"},{"title":"Comment on Post","api":"POST /v2/content","href":"/api-reference/v2/content/comment"},{"title":"Reply to Comment","api":"POST /v2/content","href":"/api-reference/v2/content/answer-comment"},{"title":"Repost","api":"POST /v2/content","href":"/api-reference/v2/content/repost"},{"title":"Get Post Comments","api":"POST /v2/content","href":"/api-reference/v2/content/get-comments"},{"title":"Get Post Reactions","api":"POST /v2/content","href":"/api-reference/v2/content/get-reactions"}]},{"group":"Recruiting","pages":[{"title":"Search Jobs","api":"POST /v2/jobs","href":"/api-reference/v2/jobs/search"},{"title":"Get Job Posts","api":"POST /v2/recruiter","href":"/api-reference/v2/recruiter/get-posts"},{"title":"Get Job Candidates","api":"POST /v2/recruiter","href":"/api-reference/v2/recruiter/get-candidates"},{"title":"Get Candidate CV","api":"POST /v2/recruiter","href":"/api-reference/v2/recruiter/get-cv"},{"title":"Create Job Posting","api":"POST /v2/recruiter","href":"/api-reference/v2/recruiter/create-job"},{"title":"Close Job Posting","api":"POST /v2/recruiter","href":"/api-reference/v2/recruiter/close-job"},{"title":"Publish Job Posting","api":"POST /v2/recruiter","href":"/api-reference/v2/recruiter/publish-job"},{"title":"Projects","sidebarTitle":"Projects","api":"POST /v2/recruiter","href":"/api-reference/v2/recruiter/projects"}]},{"group":"Credits","pages":[{"title":"Get Credit Balance","api":"GET /v2/credits","href":"/api-reference/v2/credits/get-balance"}]},{"group":"Logs","pages":[{"title":"List API Logs","api":"GET /v2/logs","href":"/api-reference/v2/logs/list-logs"}]},{"group":"Email Enrichment","pages":[{"title":"Find Email","api":"POST /v2/enrich","href":"/api-reference/v2/enrich/find-email"},{"title":"Validate Email","api":"POST /v2/enrich","href":"/api-reference/v2/enrich/validate-email"},{"title":"Reverse Email Lookup","api":"POST /v2/enrich","href":"/api-reference/v2/enrich/reverse-email"}]},{"group":"Webhooks (Real-Time)","pages":[{"title":"Webhooks Introduction","description":"Receive real-time notifications for account activity","href":"/api-reference/v2/webhooks/introduction"},{"title":"Create Webhook","api":"POST /v2/webhooks","href":"/api-reference/v2/webhooks/create"},{"title":"List Webhooks","api":"GET /v2/webhooks","description":"List all webhooks for your account","href":"/api-reference/v2/webhooks/list"},{"title":"Update Webhook","api":"PUT /v2/webhooks/{webhook_id}","href":"/api-reference/v2/webhooks/update"},{"title":"Delete Webhook","api":"DELETE /v2/webhooks/{webhook_id}","href":"/api-reference/v2/webhooks/delete"},{"title":"Start Monitoring","api":"POST /v2/webhooks/{webhook_id}/start","href":"/api-reference/v2/webhooks/start"},{"title":"Stop Monitoring","api":"POST /v2/webhooks/{webhook_id}/stop","href":"/api-reference/v2/webhooks/stop"},{"title":"Signature Verification","href":"/api-reference/v2/webhooks/signature"},{"title":"Poll Events","api":"GET /v2/webhooks/{webhook_id}/events","href":"/api-reference/v2/webhooks/events"}]}]},{"tab":"Tutorials","icon":"graduation-cap","pages":[{"title":"Tutorials","href":"/tutorials/linkedin-campaign"}]}]},{"version":"v1.5","pages":[{"title":"v1.5","href":"/api-reference/introduction"}]},{"version":"v1.0","pages":[{"title":"v1.0","href":"/api-reference/introduction"}]}]},"basePath":"","title":"Create Webhook - LinkUp API","buildId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","deploymentId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-BFmjTMeT.js","utils-BWr-sjpP.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-LafIDf0N.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-MJNzuxek.js","snippetPresets-DPZEtUvW.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DQ2UhGIs.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DUUJTUkE.js","shallow-BTf5bw35.js","getApiPlaygroundDisplay-h2POYYOO.js","CodeSnippet-C4qEftRe.js","CodeSnippets-CsSrOqMC.js","Page-CWFqNdGh.js","getPastedJson-DU6W6y78.js","icon-2ZYNQ78y.js","MethodPill-BMXJzYMm.js","DuplicateIcon-DNjdEpYZ.js","createIcon-WdPVhKxl.js","DynamicMarkdown-Z_y464fM.js","SectionHeading-Bcrd8azU.js","axios-vUo_bRtp.js"]}