Skip to content
Docs

List webhooks

GETdirect.lempile.com/api/v1/webhooks

This key's workspace's webhooks, header values masked.

Authentication

X-API-KEY header·A Lempile Direct key, one per workspace, made in Lempile's dashboard.

Query parameters

  • limitinteger

    Items per page: 1 to 250 (default 100).

    Default100≥ 1 · ≤ 250
  • cursorstring

    A cursor a previous page gave.

Responses

200

OK

›

application/json

  • objectstringrequired
    AlwaysWebhookList
  • itemsarray of Webhookrequired
    ›Show fields
    • objectstringrequired
      AlwaysWebhook
    • idstringrequired
    • account_idsarray of objectrequired
      ›Show fields
      • idstringrequired
      • namestringrequired
      • typestringrequired
        AlwaysLINKEDIN
    • enabledbooleanrequired
    • namestringrequired
    • request_urlstringrequired
    • formatstringrequired
      One ofjsonform
    • headersarray of objectrequired

      Values are always masked.

      ›Show fields
      • keystringrequired
      • valuestringrequired
        Always********
    • dataarray of WebhookDataKeyrequired
      ›Show fields
      • keystringrequired

        A key of the payload (see each source's payload).

      • namestringrequired

        The name it's sent under.

    • eventsarray of stringrequired
    • typestringrequired
      AlwaysAUTO
    • sourcestringrequired
      One ofmessagingusersaccount_status
  • cursorstring | nullrequired

    The next page's cursor, or null on the last page. Opaque: send it back as cursor.

400

A required parameter missing (errors/missing_parameters), or one that isn't valid (errors/invalid_parameters, errors/invalid_url, errors/content_too_large).

›

application/json

  • titlestringrequired

    A short title, e.g. Too many requests.

  • detailstringrequired

    What happened, in plain words. Never an account's data.

  • typestringrequired

    Unipile's error type: errors/<kind>. Branch on this, not on detail.

  • statusintegerrequired

    The HTTP status again.

  • retry_afterinteger

    Seconds to wait before trying this account again. Only on 429; the Retry-After header carries the same value.

401

errors/missing_credentials: the X-API-KEY header is missing, wrong or revoked. errors/disconnected_account: LinkedIn signed the account out (or asks it for a security check); reconnect it.

›

application/json

  • titlestringrequired

    A short title, e.g. Too many requests.

  • detailstringrequired

    What happened, in plain words. Never an account's data.

  • typestringrequired

    Unipile's error type: errors/<kind>. Branch on this, not on detail.

  • statusintegerrequired

    The HTTP status again.

  • retry_afterinteger

    Seconds to wait before trying this account again. Only on 429; the Retry-After header carries the same value.

Was this page helpful?