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/filingpulse-io:filingpulse-io-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. 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: Filingpulse Io Webhooks API
  version: 0.1.0
  contact:
    name: FilingPulse
    url: https://filingpulse.io/
    email: raxcuh06@gmail.com
  description: 'Operations tagged webhooks across 2 of this provider''s published API definitions: api.filingpulse.io-openapi.json, filingpulse-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.filingpulse.io
  description: Production
tags:
- name: Webhooks
  description: Push delivery of new filings as they land, HMAC-signed.
paths:
  /v1/webhooks:
    get:
      tags:
      - Webhooks
      summary: List your webhook subscriptions
      operationId: list_webhooks_v1_webhooks_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '401':
          description: Missing or invalid X-API-Key.
        '429':
          description: Per-minute rate limit or monthly quota exceeded. Per-minute 429s carry Retry-After; quota 429s carry X-Quota-Limit / X-Quota-Used. Quotas reset at 00:00 UTC on the 1st.
      security:
      - ApiKeyAuth: []
    post:
      tags:
      - Webhooks
      summary: Create a webhook subscription (secret shown once)
      operationId: create_webhook_v1_webhooks_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '401':
          description: Missing or invalid X-API-Key.
        '429':
          description: Per-minute rate limit or monthly quota exceeded. Per-minute 429s carry Retry-After; quota 429s carry X-Quota-Limit / X-Quota-Used. Quotas reset at 00:00 UTC on the 1st.
        '403':
          description: Active-webhook limit for your tier reached.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - ApiKeyAuth: []
    servers:
    - url: https://api.filingpulse.io
      description: Production
  /v1/webhooks/{sub_id}:
    delete:
      tags:
      - Webhooks
      summary: Deactivate a webhook subscription
      operationId: delete_webhook_v1_webhooks__sub_id__delete
      security:
      - ApiKeyAuth: []
      parameters:
      - name: sub_id
        in: path
        required: true
        schema:
          type: integer
          title: Sub Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '401':
          description: Missing or invalid X-API-Key.
        '429':
          description: Per-minute rate limit or monthly quota exceeded. Per-minute 429s carry Retry-After; quota 429s carry X-Quota-Limit / X-Quota-Used. Quotas reset at 00:00 UTC on the 1st.
        '404':
          description: No resource with that identifier (or not owned by this key).
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: https://api.filingpulse.io
      description: Production
  /v1/webhooks/{sub_id}/deliveries:
    get:
      tags:
      - Webhooks
      summary: Delivery log for a subscription
      operationId: webhook_deliveries_v1_webhooks__sub_id__deliveries_get
      security:
      - ApiKeyAuth: []
      parameters:
      - name: sub_id
        in: path
        required: true
        schema:
          type: integer
          title: Sub Id
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          description: Rows returned, newest first (max 200)
          default: 50
          title: Limit
        description: Rows returned, newest first (max 200)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '401':
          description: Missing or invalid X-API-Key.
        '429':
          description: Per-minute rate limit or monthly quota exceeded. Per-minute 429s carry Retry-After; quota 429s carry X-Quota-Limit / X-Quota-Used. Quotas reset at 00:00 UTC on the 1st.
        '404':
          description: No resource with that identifier (or not owned by this key).
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: https://api.filingpulse.io
      description: Production
components:
  schemas:
    WebhookCreate:
      properties:
        url:
          type: string
          title: Url
        events:
          items:
            type: string
          type: array
          title: Events
          default:
          - form4
          - 8k
        filters:
          additionalProperties: true
          type: object
          title: Filters
          default: {}
      type: object
      required:
      - url
      title: WebhookCreate
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: API key, e.g. fp_xxxxx. All /v1 endpoints except /v1/health and /v1/schema require one.
      in: header
      name: X-API-Key
x-refined-from:
- api.filingpulse.io-openapi.json
- filingpulse-io-openapi.json
x-provenance:
  method: harvested
  publisher: FilingPulse
  source: https://api.filingpulse.io/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)