NudgeLink Webhooks API

The webhooks API from NudgeLink — 8 operation(s) for webhooks.

GitHub OpenAPI

Operations 10

POST /api/v1/webhooks/unipile/account-connected Account Connected Webhook #
POST /api/v1/webhooks/unipile/relation-new Relation New Webhook #
POST /api/v1/webhooks/sendgrid/events Sendgrid Events Webhook #
GET /api/v1/webhooks List Endpoints #
POST /api/v1/webhooks Create Endpoint #
PATCH /api/v1/webhooks/{endpoint_id} Update Endpoint #
DELETE /api/v1/webhooks/{endpoint_id} Delete Endpoint #
POST /api/v1/webhooks/{endpoint_id}/test Send Test #
POST /api/v1/webhooks/unipile/mailbox-connected Mailbox Connected Webhook #
POST /api/v1/webhooks/unipile/email Email Webhook #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/nudgelink-co:nudgelink-co-webhooks-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nudgelink-co-webhooks-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: NudgeLink Webhooks API
  version: 0.1.0
tags:
- name: Webhooks
paths:
  /api/v1/webhooks/unipile/account-connected:
    post:
      tags:
      - Webhooks
      summary: Account Connected Webhook
      description: 'Receive Unipile''s post-hosted-auth callback and create the

        LinkedInAccount row. Idempotent on ``external_account_id``.'
      operationId: account_connected_webhook_api_v1_webhooks_unipile_account_connected_post
      parameters:
      - name: x-unipile-signature
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Unipile-Signature
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
                title: Response Account Connected Webhook Api V1 Webhooks Unipile Account Connected Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/webhooks/unipile/relation-new:
    post:
      tags:
      - Webhooks
      summary: Relation New Webhook
      description: 'Unipile ``new_relation`` (v1) / ``relation.new`` (v2): a connection was

        accepted. Stamps ``invite_accepted_at`` on any matching waiting sequence.


        Why this exists (need.md §3.2/§3.3): today acceptance is detected by the DM

        gate spending a real profile view per waiting lead per day — roughly 200/day

        on a busy seat against a 120/day budget that ONLY discovery reads and is

        never blocked by, so the failure is silent: discovery stops enriching and

        scores leads blind while outreach looks healthy. Unipile does the polling

        for this event on their side at randomised intervals, so it costs us nothing

        against LinkedIn. Documented latency is up to 8 hours.


        Always 200, even when nothing matched. Most relation events are the seat''s

        own organic networking, and a non-2xx makes Unipile retry a delivery that

        was correctly a no-op.


        Idempotent by construction: ``record_acceptance`` is write-once, so a

        re-delivered event cannot walk the timestamp forward.'
      operationId: relation_new_webhook_api_v1_webhooks_unipile_relation_new_post
      parameters:
      - name: x-unipile-signature
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Unipile-Signature
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Relation New Webhook Api V1 Webhooks Unipile Relation New Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/webhooks/sendgrid/events:
    post:
      tags:
      - Webhooks
      summary: Sendgrid Events Webhook
      description: 'Receive SendGrid event-webhook batches and apply side effects.


        Returns counters so the SendGrid dashboard ``Test event`` button shows

        a useful response.'
      operationId: sendgrid_events_webhook_api_v1_webhooks_sendgrid_events_post
      parameters:
      - name: x-twilio-email-event-webhook-signature
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Twilio-Email-Event-Webhook-Signature
      - name: x-twilio-email-event-webhook-timestamp
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Twilio-Email-Event-Webhook-Timestamp
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Sendgrid Events Webhook Api V1 Webhooks Sendgrid Events Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/webhooks:
    get:
      tags:
      - Webhooks
      summary: List Endpoints
      operationId: list_endpoints_api_v1_webhooks_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/EndpointOut'
                type: array
                title: Response List Endpoints Api V1 Webhooks Get
      security:
      - HTTPBearer: []
    post:
      tags:
      - Webhooks
      summary: Create Endpoint
      operationId: create_endpoint_api_v1_webhooks_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndpointIn'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/webhooks/{endpoint_id}:
    patch:
      tags:
      - Webhooks
      summary: Update Endpoint
      operationId: update_endpoint_api_v1_webhooks__endpoint_id__patch
      security:
      - HTTPBearer: []
      parameters:
      - name: endpoint_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Endpoint Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndpointPatch'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Webhooks
      summary: Delete Endpoint
      operationId: delete_endpoint_api_v1_webhooks__endpoint_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: endpoint_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Endpoint Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/webhooks/{endpoint_id}/test:
    post:
      tags:
      - Webhooks
      summary: Send Test
      description: Queue a ``ping`` event; the delivery worker sends it within the minute.
      operationId: send_test_api_v1_webhooks__endpoint_id__test_post
      security:
      - HTTPBearer: []
      parameters:
      - name: endpoint_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Endpoint Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: boolean
                title: Response Send Test Api V1 Webhooks  Endpoint Id  Test Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/webhooks/unipile/mailbox-connected:
    post:
      tags:
      - Webhooks
      summary: Mailbox Connected Webhook
      description: 'Unipile''s hosted-auth callback for a mailbox. Idempotent on the

        Unipile account id.'
      operationId: mailbox_connected_webhook_api_v1_webhooks_unipile_mailbox_connected_post
      parameters:
      - name: x-unipile-signature
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Unipile-Signature
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
                title: Response Mailbox Connected Webhook Api V1 Webhooks Unipile Mailbox Connected Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/webhooks/unipile/email:
    post:
      tags:
      - Webhooks
      summary: Email Webhook
      operationId: email_webhook_api_v1_webhooks_unipile_email_post
      parameters:
      - name: x-unipile-signature
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Unipile-Signature
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
                title: Response Email Webhook Api V1 Webhooks Unipile Email Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    EndpointIn:
      properties:
        url:
          type: string
          maxLength: 2048
          minLength: 12
          title: Url
        events:
          items:
            type: string
          type: array
          minItems: 1
          title: Events
      type: object
      required:
      - url
      - events
      title: EndpointIn
    EndpointOut:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        url:
          type: string
          title: Url
        events:
          items:
            type: string
          type: array
          title: Events
        enabled:
          type: boolean
          title: Enabled
        disabled_reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Disabled Reason
        consecutive_failures:
          type: integer
          title: Consecutive Failures
        created_at:
          type: string
          title: Created At
        last_delivery:
          anyOf:
          - $ref: '#/components/schemas/DeliverySummary'
          - type: 'null'
        secret:
          anyOf:
          - type: string
          - type: 'null'
          title: Secret
      type: object
      required:
      - id
      - url
      - events
      - enabled
      - consecutive_failures
      - created_at
      title: EndpointOut
    DeliverySummary:
      properties:
        status:
          type: string
          title: Status
        event_type:
          type: string
          title: Event Type
        at:
          type: string
          title: At
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
      type: object
      required:
      - status
      - event_type
      - at
      title: DeliverySummary
    EndpointPatch:
      properties:
        url:
          anyOf:
          - type: string
            maxLength: 2048
            minLength: 12
          - type: 'null'
          title: Url
        events:
          anyOf:
          - items:
              type: string
            type: array
            minItems: 1
          - type: 'null'
          title: Events
        enabled:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Enabled
      type: object
      title: EndpointPatch
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer