Webhooks

Sample events

Query

• eventstringRequired

  One of connection.sent, connection.accepted, message.sent, lead.replied, message.replied, inmail.sent, inmail.replied, lead.finished, lead.tagged, lead.interested, meeting.booked, profile.viewed, post.liked, profile.followed, lead.not_interested, lead.outcome_changed, campaign.completed, campaign.requests_paused, account.disconnected, message.first_reply, inmail.first_reply, lead.auto_tagged_positive, lead.auto_tagged_negative, lead.auto_tagged_generic.

Answer

200 OK Up to 3 events.

• dataarray of EventRequired
  Each item

  • idstringRequired

    Event ID, the same on every retry. Use it to skip repeats.

  • typeone ofRequired
    Inside it

    One of these shapes:

    Option 1: An event type

    Option 2

  • occurredAtstring · date-timeRequired
  • workspaceone ofRequired
    Inside it

    One of these shapes:

    Option 1

    • idstringRequired

      The workspace ID. Events carry the same one.

    • namestringRequired

      The workspace’s name.

    Option 2

  • leadone ofRequired
    Inside it

    One of these shapes:

    Option 1

    • idstringRequired
    • firstNamestringRequired
    • lastNamestringRequired
    • fullNamestringRequired
    • titlestringRequired
    • companystringRequired
    • locationstringRequired
    • linkedinUrlstringRequired
    • emailstring or nullRequired
    • emailStatusstring or nullRequired

      One of deliverable, catch_all, unknown.

    • tagsarray of stringRequired
    • customFieldsobjectRequired

      The lead's custom field values by field key: text, numbers, dates as YYYY-MM-DD, web addresses, and lists for Multi-select fields.

    Option 2

  • campaignobject or nullRequired
    Inside it

    • idstring
    • namestring
  • senderobject or nullRequired
    Inside it

    • idstring
    • namestring
  • messageone ofRequired
    Inside it

    One of these shapes:

    Option 1

    • idstringRequired
    • directionstringRequired

      One of inbound, outbound.

    • textstringRequired
    • subjectstring

      InMail only.

    • sentAtstring · date-timeRequired

    Option 2

  • conversationobject or nullRequired
    Inside it

    • idstring
    • channelstring

      One of linkedin, inmail.

    • linkstring
  • linkstringRequired

    Where to open this in Salesteam.

  • tagobject
    Inside it

    • idstringRequired
    • namestringRequired
  • meetingobject
    Inside it

    • atstring · date-time
  • finishobject
    Inside it

    • reasonstringRequired

      One of completed, replied, stopped, not_accepted, moved, suppressed.

  • postobject

    post.liked: the post that was liked. url is null when LinkedIn didn’t name it.

    Inside it

    • urlstring or nullRequired
  • outcomeobject

    lead.outcome_changed, and lead.not_interested from a Lost outcome: the new outcome and the one before it.

    Inside it

    • statusstringRequired

      One of interested, qualified, booked, attended, no_show, won, lost.

    • labelstringRequired

      How the app names it, like "Meeting booked".

    • previousone ofRequired
      Inside it

      One of these shapes:

      Option 1

      Option 2

  • resultsobject

    campaign.completed: the campaign’s numbers.

    Inside it

    • leadsintegerRequired

      People in the campaign.

    • contactedintegerRequired
    • acceptedintegerRequired

      Connection requests accepted.

    • repliedintegerRequired
  • acceptanceobject

    campaign.requests_paused: of the requests old enough to answer, how many were accepted, against the workspace’s safety line.

    Inside it

    • sentintegerRequired
    • acceptedintegerRequired
    • percentnumberRequired
    • thresholdintegerRequired

      The safety line, in percent.

  • accountobject

    account.disconnected: the account is sender. campaigns is how many active or paused campaigns wait for it.

    Inside it

    • statusstringRequired

      One of disconnected.

    • campaignsintegerRequired
  • sentimentstring

    Lead Auto Tagged events: how Salesteam read the first reply, which is in message. tag is the tag it added: Interested for positive, Not interested for negative, none for generic. One of positive, negative, generic.

• nextCursorstring or nullRequired

  Pass as cursor for the next page; null on the last page.

Errors

• 400 Bad requestinvalid_request invalid_json duplicate_in_request
• 401 Unauthorizedunauthorized
• 429 Too many requestsrate_limited
• 500 Server errorserver_error

Every error has the same shape. See Errors.