Webhooks

Subscribe to signed events

Changed on

Maximum 10 enabled hooks. Save the returned secret securely; it is shown only at creation. HTTPS port 443 and publicly resolving IPv4 DNS required. Private/mixed IPs, URL credentials, fragments and redirects are rejected. Registration is not idempotent: list before retrying after a timeout; 409 webhook_limit_reached at the maximum. Delivery is best-effort: up to three attempts, retried on network errors, 5xx and 429; not a durable replay queue. Verify signatures on the exact raw body (X-PumpGTM-Signature, t=<unix>,v1=<hex HMAC-SHA256 of t + "." + body>; reject t older than 5 minutes) and deduplicate event IDs. x.followed means an inbound follow of your connected account. lead.messaged includes successful x_dm with channel x; reply.received can include unreadable encrypted content. linkedin.connected fires on the partner workspace when an end user completes a hosted connect link; register it with the partner key. linkedin.disconnected fires when a connected LinkedIn identity stops being usable (source: provider, dashboard or api), on the owning workspace and, for a partner end user, on the partner workspace. linkedin.limited fires once when LinkedIn declines an account's connection requests and invites are held (data.account{id,displayName}, reason invite_limit, heldSince, retryAt = earliest automatic retry, attempt 1..3; a failed retry fires it again with the next attempt); linkedin.resumed fires when a retry goes through (data.account, resumedAt, warmupRestarted true: the account re-enters the six-day warm-up ramp). Messages and other steps keep running during a hold; nothing to do on your side.

post/webhooks

Request

  • Base URL
    https://app.pumpgtm.com/api/v1
  • Auth
    HTTP bearer

Headers

X-PumpGTM-Clientstring uuid

Optional authorized Team workspace ID from GET /workspaces. Omit to use the key's home workspace.

X-PumpGTM-Userstring

Enterprise partners: act on one end user's workspace using the partner key (a workspace or Team owner key; a personal key gets 403 partner_key_required). Requires the outreach capability on the partner account (403 enterprise_required otherwise); the user must exist and be active (404 user_not_found, 403 user_disabled). Never send it together with X-PumpGTM-Client (400 invalid_request). Omit to use the key's own workspace, unless the partner account has rest.requireUserHeader on (PATCH /api/partner/v1/account): then any /api/v1 request without it is 400 user_header_required and nothing runs.

Request body

urlstring uri required
eventsstring[] required

Response

Successful response. Read outcome fields; success does not imply delivery.

idstring uuid required
urlstring required
eventsstring[] required
secretstring required

Changes

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      endpoint added