Skip to main content
POST
Create Webhook
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 secret once — store it; it cannot be retrieved later. See Signature Verification.

Response

boolean
Whether the webhook was created successfully
object

Notes

  • 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.