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/apisign-io:apisign-io-webhooks-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Sign Webhooks API
  description: 'Programmatically create, send, and manage contracts for e-signatures. Contracts are created as drafts and charged when sent ($0.25 per send at the default price; test-mode sends are free). Errors return `{ "error": string }`; request validation errors add a `details` array. API key requests are not rate limited.'
  version: 1.0.0
  contact:
    name: API Sign Support
    url: https://apisign.io
servers:
- url: https://apisign.io/api
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: Webhooks
  description: Configure webhook endpoints for events
paths:
  /webhook/create:
    post:
      summary: Create a webhook
      description: Create a webhook endpoint. The signing secret is returned only in this response.
      operationId: createWebhook
      tags:
      - Webhooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebhookRequest'
      responses:
        '200':
          description: Webhook created
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhook:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      url:
                        type: string
                        format: uri
                      events:
                        type: array
                        items:
                          $ref: '#/components/schemas/WebhookEventType'
                      status:
                        $ref: '#/components/schemas/WebhookStatus'
                      secret:
                        type: string
                        description: Signing secret. Shown only once.
                      createdAt:
                        type: string
                        format: date-time
                  message:
                    type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
  /webhook/list:
    get:
      summary: List webhooks
      description: List the organization's webhooks, newest first. Secrets are not included.
      operationId: listWebhooks
      tags:
      - Webhooks
      responses:
        '200':
          description: List of webhooks
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhooks:
                    type: array
                    items:
                      $ref: '#/components/schemas/Webhook'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
  /webhook/get:
    get:
      summary: Get a webhook
      description: Get a webhook with its 20 most recent deliveries. The secret is replaced by `hasSecret`.
      operationId: getWebhook
      tags:
      - Webhooks
      parameters:
      - name: id
        in: query
        required: true
        schema:
          type: string
        description: Webhook ID
      responses:
        '200':
          description: Webhook details
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhook:
                    allOf:
                    - $ref: '#/components/schemas/Webhook'
                    - type: object
                      properties:
                        orgId:
                          type: string
                        headers:
                          type: object
                          additionalProperties:
                            type: string
                        hasSecret:
                          type: boolean
                        deliveries:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              eventType:
                                $ref: '#/components/schemas/WebhookEventType'
                              status:
                                $ref: '#/components/schemas/WebhookDeliveryStatus'
                              attempts:
                                type: integer
                              responseCode:
                                type:
                                - integer
                                - 'null'
                              errorMessage:
                                type:
                                - string
                                - 'null'
                              createdAt:
                                type: string
                                format: date-time
                              completedAt:
                                type:
                                - string
                                - 'null'
                                format: date-time
                              durationMs:
                                type:
                                - integer
                                - 'null'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
  /webhook/update:
    post:
      summary: Update a webhook
      description: Update a webhook. Only the properties sent are changed. Setting `status` to `active` resets the failure count.
      operationId: updateWebhook
      tags:
      - Webhooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWebhookRequest'
      responses:
        '200':
          description: Webhook updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhook:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      url:
                        type: string
                      events:
                        type: array
                        items:
                          $ref: '#/components/schemas/WebhookEventType'
                      status:
                        $ref: '#/components/schemas/WebhookStatus'
                      headers:
                        type: object
                        additionalProperties:
                          type: string
                      updatedAt:
                        type: string
                        format: date-time
                  message:
                    type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
  /webhook/delete:
    post:
      summary: Delete a webhook
      description: Delete a webhook and its delivery history.
      operationId: deleteWebhook
      tags:
      - Webhooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - id
              properties:
                id:
                  type: string
                  description: Webhook ID
      responses:
        '200':
          description: Webhook deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
  /webhook/rotate-secret:
    post:
      summary: Rotate a webhook secret
      description: Generate a new signing secret. The old secret stops working immediately; the new one is shown only in this response.
      operationId: rotateWebhookSecret
      tags:
      - Webhooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - id
              properties:
                id:
                  type: string
                  description: Webhook ID
      responses:
        '200':
          description: Secret rotated
          content:
            application/json:
              schema:
                type: object
                properties:
                  secret:
                    type: string
                  message:
                    type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
  /webhook/test:
    post:
      summary: Send a test event
      description: 'Send a sample `contract_signed` payload (with `test: true`) to the webhook URL and return the result.'
      operationId: testWebhook
      tags:
      - Webhooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - id
              properties:
                id:
                  type: string
                  description: Webhook ID
      responses:
        '200':
          description: Test result
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  durationMs:
                    type: integer
                  responseCode:
                    type:
                    - integer
                    - 'null'
                  responseBody:
                    type:
                    - string
                    - 'null'
                    description: First 1000 characters of the response
                  errorMessage:
                    type:
                    - string
                    - 'null'
                  payload:
                    type: object
                  headers:
                    type: object
                    additionalProperties:
                      type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
  /webhook/logs:
    get:
      summary: List a webhook's deliveries
      description: Delivery history for one webhook, newest first.
      operationId: getWebhookLogs
      tags:
      - Webhooks
      parameters:
      - name: webhookId
        in: query
        required: true
        schema:
          type: string
        description: Webhook ID (camelCase parameter name)
      - name: page
        in: query
        required: false
        schema:
          type: integer
          default: 1
          minimum: 1
        description: Page number
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 50
          minimum: 1
        description: Results per page
      responses:
        '200':
          description: Deliveries
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhook:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      url:
                        type: string
                  deliveries:
                    type: array
                    items:
                      $ref: '#/components/schemas/WebhookDelivery'
                  pagination:
                    type: object
                    properties:
                      page:
                        type: integer
                      limit:
                        type: integer
                      totalCount:
                        type: integer
                      totalPages:
                        type: integer
                      hasNext:
                        type: boolean
                      hasPrev:
                        type: boolean
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  responses:
    ServerError:
      description: Internal server error (also returned for a request body that is not valid JSON)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Invalid request, or the action is not allowed in the resource's current state
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: 'Missing, invalid, expired or deleted API key. Body: `{ "error": "Unauthorized" }`'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found in this organization
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          description: Error message
        details:
          type: array
          description: Present on request validation errors
          items:
            type: object
            properties:
              field:
                type: string
                description: Dot path of the invalid field
              message:
                type: string
    UpdateWebhookRequest:
      type: object
      required:
      - id
      properties:
        id:
          type: string
        name:
          type: string
          minLength: 1
          maxLength: 100
        url:
          type: string
          format: uri
        events:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/WebhookEventType'
        headers:
          type: object
          additionalProperties:
            type: string
        status:
          type: string
          enum:
          - active
          - inactive
    WebhookStatus:
      type: string
      enum:
      - active
      - inactive
      - failed
    Webhook:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        url:
          type: string
          format: uri
        status:
          $ref: '#/components/schemas/WebhookStatus'
        events:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEventType'
        failureCount:
          type: integer
        lastSuccess:
          type:
          - string
          - 'null'
          format: date-time
        lastFailure:
          type:
          - string
          - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    WebhookDeliveryStatus:
      type: string
      enum:
      - pending
      - success
      - failed
      - retrying
    CreateWebhookRequest:
      type: object
      required:
      - name
      - url
      - events
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 100
        url:
          type: string
          format: uri
        events:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/WebhookEventType'
        headers:
          type: object
          additionalProperties:
            type: string
          description: Extra headers sent with each delivery
    WebhookDelivery:
      type: object
      properties:
        id:
          type: string
        eventType:
          $ref: '#/components/schemas/WebhookEventType'
        status:
          $ref: '#/components/schemas/WebhookDeliveryStatus'
        attempts:
          type: integer
        maxAttempts:
          type: integer
        responseCode:
          type:
          - integer
          - 'null'
        responseBody:
          type:
          - string
          - 'null'
        errorMessage:
          type:
          - string
          - 'null'
        createdAt:
          type: string
          format: date-time
        lastAttempt:
          type:
          - string
          - 'null'
          format: date-time
        nextAttempt:
          type:
          - string
          - 'null'
          format: date-time
        completedAt:
          type:
          - string
          - 'null'
          format: date-time
        durationMs:
          type:
          - integer
          - 'null'
        payload:
          type: object
    WebhookEventType:
      type: string
      enum:
      - contract_created
      - contract_sent
      - contract_resent
      - contract_viewed
      - contract_signed
      - contract_completed
      - contract_declined
      - contract_expired
      - contract_cancelled
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key from the dashboard (Account → MCP & API Keys). Keys start with `ask_`. A key's `read`/`read_write` permission applies only to the MCP server; REST endpoints do not check it.