past-dev Webhooks API

openapi: 3.2.0
info:
  title: Past Dev Webhooks API
  version: 1.0.0
  contact:
    name: past.dev
    url: https://past.dev/call
    email: support@past.dev
  description: 'Operations tagged webhooks across 2 of this provider''s published API definitions: past-dev-openapi.json, past-dev.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.past.dev
  description: Production
security:
- bearerAuth: []
tags:
- name: Webhooks
  description: Receive events from another system on a URL the console issues.
paths:
  /api/v1/webhooks/{webhookId}/{token}:
    post:
      operationId: receiveWebhookEvent
      tags:
      - Webhooks
      summary: Receive one event on a webhook URL
      description: 'Receive one event from another system. The console issues the complete URL when the webhook is created, and the token in it is the credential: the route takes no bearer. A JSON body is read by the webhook''s mapping and filters; any other body is used whole as the content. Returns 202 when the event becomes a data point and 200 when a filter or the content mapping drops it. Each event received costs 0.1 credit; an ingested event also costs the ingestion credits of its content.'
      security: []
      parameters:
      - name: webhookId
        in: path
        required: true
        schema:
          type: string
        description: The webhook id, beginning with whk_.
      - name: token
        in: path
        required: true
        schema:
          type: string
        description: The 32-character token of the webhook URL. It is the credential.
      requestBody:
        required: true
        content:
          '*/*':
            schema:
              description: The sender's own body, 1 MiB or less.
      responses:
        '200':
          description: 'The event was dropped: a filter did not match, or the content path resolved to nothing. It costs 0.1 credit and creates no data point.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookReceipt'
        '202':
          description: The event was ingested as a data point. unchanged is true when it repeats a data point whose content and time are unchanged.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookReceipt'
        '400':
          description: 'audience-unknown: the audience of the webhook was deleted.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: 'webhooks-not-included: the plan does not include webhooks. out-of-credits: the organization''s credits are spent.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: 'not-found: the id or the token is wrong, or the webhook is deleted. A wrong token never returns 401.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: 'webhook-paused: the webhook is paused. Events sent during the pause are not kept.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: 'webhook-body-too-large: the body is larger than 1 MiB.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: project-cap-reached or spend-cap-reached, or the webhook is past its limit of 600 events in one minute. The per-minute refusal carries no body.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: The organization is not ready or background ingestion is disabled.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Any other failure uses the same JSON error envelope.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://api.past.dev
      description: Production
components:
  schemas:
    WebhookReceipt:
      type: object
      required:
      - eventId
      - requestId
      - verdict
      additionalProperties: false
      properties:
        eventId:
          type: string
          description: The id of the event, beginning with evt_, assigned at receipt.
        requestId:
          type: string
          description: The id of this call, as in the X-Request-Id header.
        verdict:
          type: string
          enum:
          - ingested
          - dropped
        droppedBy:
          type:
          - string
          - 'null'
          description: 'On a dropped event: the first filter that did not match, or the missing content. Null on an ingested event.'
        ingestionId:
          type:
          - string
          - 'null'
          format: uuid
          description: The ingestion id of an ingested event, read with the ingestion status operation. Null on a dropped event.
        dataPointId:
          type:
          - string
          - 'null'
          description: 'The source id of the data point: the mapped id, or the event id when the webhook maps none. Null on a dropped event.'
        unchanged:
          type:
          - boolean
          - 'null'
          description: True when the event repeats a data point whose content and time are unchanged.
    Error:
      type: object
      required:
      - code
      - status
      properties:
        code:
          type: string
          description: Stable kebab-case identifier.
        status:
          type: integer
          description: HTTP status repeated in the body.
        debugMessage:
          type: string
        data: {}
  headers:
    RequestId:
      description: Server-generated id of this call, beginning with req_. Present on every /api/v1 response. The console's Requests screen lists the call under it.
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Project API key beginning with past_sk_.
    managementKeyAuth:
      type: http
      scheme: bearer
      description: Management key beginning with past_mk_. One per organization, created from Settings in the console.
    agentTokenAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Agent access token for one person, issued by https://sso.past.dev after the person approves the agent. https://api.past.dev/auth.md gives the procedure. The operation names the scope it asks for: memory:read or memory:write. Send X-Past-Project with the project slug; without it, the only live project of the organization is used, and an organization with two or more returns 400 project-required. Managed service only.'
x-refined-from:
- past-dev-openapi.json
- past-dev.json