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/dregs-com:dregs-com-channels-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: Dregs Channels API
  description: 'Customer REST API for sending events and reading fraud scores, identities, devices, escalations, channels, datasets, and mappings.


    Authenticate with a secret key created in the dashboard under Settings > Credentials (security scheme secretKey). Send it as a Bearer token: Authorization: Bearer sk_... The key acts as an admin of that credential''s team. POST /api/events and GET /api/devices/{fingerprint} also accept the credential''s public key (security scheme publicKey, Bearer pk_...). Public keys may be embedded in a browser. Secret keys must not.


    This document is the curated public surface. Dashboard sign-in, billing, team administration, and trainer tools are not included.'
  version: '1.0'
servers:
- url: https://dregs.com
  description: Dregs API
security:
- secretKey: []
tags:
- name: Channels
  description: Notification channel management
paths:
  /api/channels:
    get:
      tags:
      - Channels
      summary: List channels
      description: Returns all notification channels for the current team
      operationId: listChannels
      responses:
        '200':
          description: Channels retrieved successfully
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/V1Channel'
        '401':
          description: Authentication required
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/V1Channel'
      security:
      - secretKey: []
    post:
      tags:
      - Channels
      summary: Create channel
      description: Creates a new notification channel. A webhook channel's response includes the signing secret, which is shown only this once. Other channel types return the channel without a secret.
      operationId: createChannel
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1CreateChannelRequest'
        required: true
      responses:
        '200':
          description: Channel created. Webhook channels include the signing secret.
          content:
            application/json:
              schema:
                description: A webhook channel includes its signing secret. Other channel types do not.
                oneOf:
                - $ref: '#/components/schemas/V1Channel'
                - $ref: '#/components/schemas/V1ChannelWithSecret'
        '400':
          description: Invalid request
          content:
            '*/*':
              schema:
                type: object
        '403':
          description: Admin role required
          content:
            '*/*':
              schema:
                type: object
      security:
      - secretKey: []
  /api/channels/{id}/test:
    post:
      tags:
      - Channels
      summary: Test channel
      description: Sends a test delivery to the channel
      operationId: testChannel
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Test delivery scheduled
        '404':
          description: Channel not found
        '401':
          description: Authentication required
        '403':
          description: Admin role required
      security:
      - secretKey: []
  /api/channels/{id}:
    get:
      tags:
      - Channels
      summary: Get channel
      description: Returns a single channel by ID
      operationId: getChannel
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Channel found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1Channel'
        '404':
          description: Channel not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1Channel'
      security:
      - secretKey: []
    delete:
      tags:
      - Channels
      summary: Delete channel
      description: Deletes a notification channel
      operationId: deleteChannel
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: Channel deleted
        '403':
          description: Admin role required
        '404':
          description: Channel not found
      security:
      - secretKey: []
    patch:
      tags:
      - Channels
      summary: Update channel
      description: Updates an existing notification channel
      operationId: updateChannel
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1UpdateChannelRequest'
        required: true
      responses:
        '200':
          description: Channel updated
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1Channel'
        '403':
          description: Admin role required
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1Channel'
        '404':
          description: Channel not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1Channel'
      security:
      - secretKey: []
  /api/channels/{id}/deliveries:
    get:
      tags:
      - Channels
      summary: Get channel deliveries
      description: Returns delivery history for a channel
      operationId: listChannelDeliveries
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: size
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 20
      responses:
        '200':
          description: Deliveries retrieved successfully
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PageV1ChannelDelivery'
        '404':
          description: Channel not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PageV1ChannelDelivery'
        '401':
          description: Authentication required
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PageV1ChannelDelivery'
      security:
      - secretKey: []
components:
  schemas:
    V1ChannelWithSecret:
      type: object
      properties:
        id:
          type: integer
          format: int64
        slug:
          type: string
        name:
          type: string
        type:
          type: string
          enum:
          - EMAIL
          - WEBHOOK
          - SLACK
          - SMS
        config:
          type: object
          additionalProperties: {}
        secret:
          type: string
        enabled:
          type: boolean
        createdAt:
          type: string
          format: date-time
    V1ChannelDelivery:
      type: object
      properties:
        id:
          type: integer
          format: int64
        trigger:
          type: string
          enum:
          - IDENTITY_SCORED
          - IDENTITY_BADGES_CHANGED
          - ESCALATION_OPENED
          - ESCALATION_CLOSED
          - TEST
        status:
          type: string
          enum:
          - PENDING
          - DELIVERED
          - FAILED
        statusCode:
          type: integer
          format: int32
        payloadSize:
          type: integer
          format: int32
        errorMessage:
          type: string
        attemptNumber:
          type: integer
          format: int32
        deliveredAt:
          type: string
          format: date-time
        failedAt:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
    PageableObject:
      type: object
      properties:
        offset:
          type: integer
          format: int64
        unpaged:
          type: boolean
        paged:
          type: boolean
        pageNumber:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
        sort:
          $ref: '#/components/schemas/SortObject'
    SortObject:
      type: object
      properties:
        empty:
          type: boolean
        sorted:
          type: boolean
        unsorted:
          type: boolean
    V1Channel:
      type: object
      properties:
        id:
          type: integer
          format: int64
        slug:
          type: string
        name:
          type: string
        type:
          type: string
          enum:
          - EMAIL
          - WEBHOOK
          - SLACK
          - SMS
        config:
          type: object
          additionalProperties: {}
        enabled:
          type: boolean
        createdAt:
          type: string
          format: date-time
    PageV1ChannelDelivery:
      type: object
      properties:
        totalElements:
          type: integer
          format: int64
        totalPages:
          type: integer
          format: int32
        size:
          type: integer
          format: int32
        content:
          type: array
          items:
            $ref: '#/components/schemas/V1ChannelDelivery'
        number:
          type: integer
          format: int32
        numberOfElements:
          type: integer
          format: int32
        pageable:
          $ref: '#/components/schemas/PageableObject'
        sort:
          $ref: '#/components/schemas/SortObject'
        first:
          type: boolean
        last:
          type: boolean
        empty:
          type: boolean
    V1CreateChannelRequest:
      type: object
      properties:
        name:
          type: string
        type:
          type: string
        config:
          type: object
          additionalProperties: {}
        secrets:
          type: object
          additionalProperties: {}
    V1UpdateChannelRequest:
      type: object
      properties:
        name:
          type: string
        config:
          type: object
          additionalProperties: {}
        secrets:
          type: object
          additionalProperties: {}
        enabled:
          type: boolean
  securitySchemes:
    secretKey:
      type: http
      description: Customer secret key from Settings > Credentials, sent as a Bearer token. The token value starts with sk_. It acts as an admin of that credential's team for every operation in this document. MCP tokens (dmcp_) are refused. Prefer the publicKey scheme on operations that accept a pk_ key.
      scheme: bearer
      bearerFormat: sk_
    publicKey:
      type: http
      description: Customer public key from Settings > Credentials, sent as a Bearer token. The token value starts with pk_. Accepted only by POST /api/events and GET /api/devices/{fingerprint}. It may be embedded in a browser. It cannot call the other operations in this document.
      scheme: bearer
      bearerFormat: pk_