Converly Events API

The Events API from Converly — 2 operation(s) for events.

GitHub OpenAPI

Operations 2

GET /events Get events #
GET /events/{id} Get events by id #

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/converly-io:converly-io-events-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.

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

OpenAPI Specification

converly-io-events-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Converly Io Events API
  version: 1.0.0
  description: 'Operations tagged Events across 2 of this provider''s published API definitions: converly-io-openapi.json, converly-io-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://app.converly.io/api/v1
tags:
- name: Events
paths:
  /events:
    get:
      description: 'List recent events newest-first as a BOUNDED SNAPSHOT (not cursor-paged). Filters: site_id (one site) + flow_id (both server-side), and email / status / occurred_after / occurred_before (applied to the fetched window — recent events, not the full archive). `has_more: true` means older events exist beyond the window; narrow with filters rather than paging. `complete: false` means a filter truncated the search, so an empty result does NOT prove no match exists. Cursor params (starting_after / ending_before) are NOT supported and return 400 invalid_cursor — a bare timestamp cursor would silently skip same-timestamp events. Max limit is 100 (lower than other endpoints). Read-only — no POST /events; events are ingested by the snippet + delivery service, not by API clients.'
      security:
      - BearerAuth: []
      parameters:
      - schema:
          $ref: '#/components/schemas/SiteId'
        required: false
        description: Prefixed site id, e.g. site_xxxxxx
        name: site_id
        in: query
      - schema:
          $ref: '#/components/schemas/FlowId'
        required: false
        description: Prefixed flow id, e.g. flow_xxxxxx
        name: flow_id
        in: query
      - schema:
          type: string
        required: false
        name: email
        in: query
      - schema:
          type: string
        required: false
        name: status
        in: query
      - schema:
          type: string
          format: date-time
        required: false
        name: occurred_after
        in: query
      - schema:
          type: string
          format: date-time
        required: false
        name: occurred_before
        in: query
      - schema:
          type: integer
          minimum: 1
          maximum: 100
        required: false
        name: limit
        in: query
      responses:
        '200':
          description: Bounded snapshot of recent events.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedEvents'
        '400':
          description: Structured error envelope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Structured error envelope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: Structured error envelope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      tags:
      - Events
      summary: Get events
      x-summary-source: derived
      operationId: getEvents
      x-operation-id-source: derived
    servers:
    - url: https://app.converly.io/api/v1
  /events/{id}:
    get:
      description: Get one event by id. 404 if the event doesn't exist OR belongs to a site on a different account (tenant isolation — no existence leak).
      security:
      - BearerAuth: []
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      responses:
        '200':
          description: The event.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Event'
        '404':
          description: Structured error envelope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      tags:
      - Events
      summary: Get events by id
      x-summary-source: derived
      operationId: getEventsById
      x-operation-id-source: derived
    servers:
    - url: https://app.converly.io/api/v1
components:
  schemas:
    PaginatedEvents:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Event'
        has_more:
          type: boolean
        next_cursor:
          type:
          - string
          - 'null'
        complete:
          type: boolean
      required:
      - data
      - has_more
      - next_cursor
      - complete
    FlowId:
      type: string
      pattern: ^flow_[0-9A-Za-z]{22}$
      description: Prefixed flow id, e.g. flow_xxxxxx
    SiteId:
      type: string
      pattern: ^site_[0-9A-Za-z]{22}$
      description: Prefixed site id, e.g. site_xxxxxx
    ErrorEnvelope:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
              - invalid_request_error
              - authentication_error
              - permission_error
              - not_found_error
              - rate_limit_error
              - delivery_service_error
              - internal_error
              - idempotency_error
            code:
              type: string
            message:
              type: string
            param:
              type: string
          required:
          - type
          - code
          - message
      required:
      - error
    Event:
      type: object
      properties:
        id:
          type: string
          description: '`evt_` + opaque body. NOT the same format as other prefixed IDs — event bodies are pass-through from the delivery service, not base62-encoded UUIDs.'
        site_key:
          type: string
        occurred_at:
          type:
          - string
          - 'null'
          format: date-time
        flow_id:
          type:
          - string
          - 'null'
        flow_name:
          type:
          - string
          - 'null'
        trigger:
          type:
          - string
          - 'null'
        status:
          type:
          - string
          - 'null'
        actions:
          type: array
          items:
            type: object
            additionalProperties: {}
      required:
      - id
      - site_key
      - occurred_at
      - flow_id
      - flow_name
      - trigger
      - status
      - actions
      additionalProperties: {}
      description: 'Read-only conversion event. REDACTED BY DEFAULT: visitor PII (IP, user agent, browser/ad-platform identifiers, captured user_data, request/response bodies) is removed, and get_event_detail-level responses expose coarse device, redacted paths, and PRESENCE-ONLY user_data flags. Full-fidelity fields are returned only to credentials holding the `events:read:pii` scope (first-party plugins / the dashboard) — the MCP surface is ALWAYS redacted. The extra fields under that scope are pass-through from the delivery service. See docs/PII-PLAN-FINAL.md.'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: sk_live_...
    InternalBearer:
      type: http
      scheme: bearer
      bearerFormat: JOBS_SECRET
      description: Shared internal secret. This is NOT an sk_live_* API key. Used by /v1/signup and internal job endpoints.
x-refined-from:
- converly-io-openapi.json
- converly-io-openapi.yml