Skip to main content
POST
Create webhook

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of create_webhook.

name
string
required
Required string length: 1 - 255
target_url
string
required

https:// only, public IP only.

Maximum string length: 2048
events
enum<string>[]
required

At least one WebhookEventTypeEnum value.

Minimum array length: 1
Available options:
linkedin-accounts.created,
linkedin-accounts.restored,
linkedin-accounts.deleted,
linkedin-accounts.initial-sync-started,
linkedin-accounts.initial-sync-done,
linkedin-accounts.sync-reset,
linkedin-accounts.premium-changed,
linkedin-accounts.login-succeeded,
linkedin-accounts.login-failed,
linkedin-accounts.logged-out,
linkedin-accounts.heartbeat-stale,
linkedin-account-block-log.recorded,
linkedin-account-snapshot.captured,
linkedin-account-quota-hits.recorded,
linkedin-account-smart-limits.limit-reached,
linkedin-account-smart-limits.limit-released,
linkedin-account-smart-limits.smart-limit-recomputed,
linkedin-connection-requests.sent,
linkedin-connection-requests.accepted,
linkedin-connection-requests.withdrawn,
linkedin-connection-requests.expired-detected,
linkedin-connection-requests.resend-available,
linkedin-connection-requests.sync-completed,
linkedin-connection-invitations.received,
linkedin-connection-invitations.accepted,
linkedin-connection-invitations.ignored,
linkedin-connection-invitations.expired-detected,
linkedin-connection-invitations.sync-completed,
linkedin-connections.added,
linkedin-connections.removed,
linkedin-connections.sync-completed,
linkedin-followers.added,
linkedin-messages.received,
linkedin-messages.sent,
linkedin-messages.send-failed,
linkedin-conversations.created,
linkedin-conversations.sync-completed,
data-requests.completed,
data-requests.failed,
linkedin-auto-scrape-runs.completed,
linkedin-auto-scrape-runs.failed,
linkedin-auto-scrapes.paused,
antidetect-browsers.logged-in,
antidetect-browsers.logged-out,
antidetect-browsers.started,
antidetect-browsers.stopped,
antidetect-browsers.start-failed,
antidetect-browsers.running-issue,
antidetect-browsers.error-investigation,
antidetect-browsers.maintenance,
antidetect-browsers.proxy-issue,
antidetect-browsers.proxy-back-alive,
antidetect-browsers.idle,
account-shares.created,
account-shares.returned,
account-shares.recalled,
account-shares.failed,
account-transfers.completed,
account-transfers.failed,
webhooks.failed,
email-accounts.connected,
email-accounts.reconnect-required,
email-accounts.sending-paused,
email-accounts.sending-resumed,
email-accounts.disconnected,
email-accounts.deleted,
email-accounts.sync-completed,
email-messages.received,
email-messages.sent,
email-messages.bounced,
email-messages.complained,
email-messages.failed,
email-messages.deleted,
email-threads.updated,
email-engagements.opened,
email-engagements.clicked,
email-engagements.unsubscribed,
email-account-health.snapshot-captured,
email-account-health.score-critical,
email-suppressions.created,
email-suppressions.deleted,
email-tracking-domains.verified,
email-tracking-domains.failed,
email-sending-domains.verified,
email-sending-domains.failed,
mass-actions.created,
mass-actions.paused,
mass-actions.resumed,
mass-actions.settled
filters
object

Optional narrowing (e.g. status, events).

Response

create success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
create
item
object
required
already_exists
boolean
required
meta
object
required