MagicBell

MagicBell Ping Email API

The ping_email API from MagicBell — 1 operation(s) for ping_email.

Documentation GitHub OpenAPI

Operations 3

GET /integrations/ping_email List all Ping Email integrations #

PUT /integrations/ping_email Save a Ping Email integration #

DELETE /integrations/ping_email Delete a Ping Email integration #

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/magicbell:magicbell-ping-email-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: MagicBell Ping Email API
  description: OpenAPI 3.1.0 Specification for MagicBell API.
  contact:
    name: MagicBell
    url: https://wwww.magicbell.com
  version: 2.0.0
servers:
- url: https://api.magicbell.com/v2
  description: MagicBell API (v2) Base URL
tags:
- name: ping_email
paths:
  /integrations/ping_email:
    summary: Ping email diagnostics
    description: Synthetic email integration that helps you validate deliverability SLAs by periodically sending canary messages.
    get:
      tags:
      - ping_email
      summary: List all Ping Email integrations
      description: Retrieves the current Ping Email integration configurations for a specific integration type in the project. Returns configuration details and status information.
      operationId: list_ping_email_integrations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PingConfigCollection'
      x-magicbell-auth-jwt-type: project
      x-meta:
        channel: email
        displayName: Ping Email
        name: ping_email
    put:
      tags:
      - ping_email
      summary: Save a Ping Email integration
      description: Updates or creates the Ping Email integration for the project.
      operationId: save_ping_email_integration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PingConfigPayload'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PingConfigPayload'
      x-magicbell-auth-jwt-type: project
      x-meta:
        channel: email
        displayName: Ping Email
        name: ping_email
    delete:
      tags:
      - ping_email
      summary: Delete a Ping Email integration
      description: Deletes the Ping Email integration configuration from the project. This will disable the integration's functionality within the project.
      operationId: delete_ping_email_integration
      parameters:
      - name: id
        in: query
        description: the unique identifier of the integration to be deleted
        required: false
        schema:
          type: string
      responses:
        '204':
          description: No Content
      x-magicbell-auth-jwt-type: project
      x-meta:
        channel: email
        displayName: Ping Email
        name: ping_email
components:
  schemas:
    PingConfigPayload:
      $schema: http://json-schema.org/draft-07/schema#
      examples:
      - url: https://example.com/webhook
      properties:
        url:
          description: URL to ping
          format: uri
          maxLength: 100
          minLength: 1
          type: string
      required:
      - url
      type: object
    PingConfigCollection:
      examples:
      - data:
        - config:
            url: https://example.com/webhook
          id: '123'
          name: <provider-name>
        links:
          first: https://api.magicbell.com/v1/example
          next: https://api.magicbell.com/v1/example?page_next=abc
          prev: null
      properties:
        data:
          items:
            $ref: '#/components/schemas/PingConfig'
          type: array
        links:
          $ref: '#/components/schemas/Links'
      type: object
    Links:
      properties:
        first:
          type: string
        next:
          type:
          - string
          - 'null'
        prev:
          type:
          - string
          - 'null'
      type: object
    PingConfig:
      properties:
        config:
          $ref: '#/components/schemas/PingConfigPayload'
        id:
          type: string
        name:
          type: string
      required:
      - name
      - id
      - config
      type: object
x-provenance:
  method: harvested
  publisher: MagicBell
  source: https://www.magicbell.com/docs/api/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)