MepMail Webhooks API

Signed event deliveries to your endpoints.

GitHub OpenAPI

Operations 6

POST /webhooks Create a webhook #
GET /webhooks List webhooks #
GET /webhooks/{id} Retrieve a webhook #
PATCH /webhooks/{id} Update a webhook #
DELETE /webhooks/{id} Delete a webhook #
POST /webhooks/{id}/rotate Rotate a webhook's signing secret #

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/mepmail-dev:mepmail-dev-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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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

OpenAPI Specification

mepmail-dev-webhooks-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Mepmail Dev Webhooks API
  version: 1.0.0
  description: 'Operations tagged Webhooks across 2 of this provider''s published API definitions: docs.json, mepmail-dev-docs-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.mepmail.dev
  description: MepMail Cloud
- url: '{baseUrl}'
  description: Self-hosted instance
  variables:
    baseUrl:
      default: http://localhost:3001
security:
- apiKey: []
tags:
- name: Webhooks
  description: Signed event deliveries to your endpoints.
paths:
  /webhooks:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebhookRequest'
            example:
              endpoint: https://example.com/webhooks/mepmail
              events:
              - email.delivered
              - email.bounced
      responses:
        '200':
          description: Webhook created; signing_secret is also retrievable via GET /webhooks/{id}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWebhookResponse'
              example:
                object: webhook
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
                signing_secret: signing secret
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: createWebhook
      summary: Create a webhook
      tags:
      - Webhooks
      description: Registers an endpoint for the chosen events and returns its signing secret.
    get:
      parameters:
      - schema:
          type: integer
          minimum: 1
          maximum: 100
          description: Page size, 1-100 (default 20)
        required: false
        description: Page size, 1-100 (default 20)
        name: limit
        in: query
      - schema:
          type: string
          format: uuid
          description: 'Cursor: id of the last item of the previous page. Must be an id this list returned; there is no sentinel value.'
        required: false
        description: 'Cursor: id of the last item of the previous page. Must be an id this list returned; there is no sentinel value.'
        name: after
        in: query
      - schema:
          type: string
          format: uuid
          description: 'Cursor: id of the first item of the next page (page backwards); same rule as after.'
        required: false
        description: 'Cursor: id of the first item of the next page (page backwards); same rule as after.'
        name: before
        in: query
      responses:
        '200':
          description: Webhooks (list rows never carry the signing secret)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWebhooksResponse'
              example:
                object: list
                data:
                - id: 4ef9a417-02e9-4d39-ad75-9611e0fcc33c
                  endpoint: https://example.com/webhooks/mepmail
                  created_at: '2026-10-19T12:00:00.000Z'
                  status: enabled
                  events:
                  - event
                has_more: false
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: listWebhooks
      summary: List webhooks
      tags:
      - Webhooks
      description: Lists the team's webhooks.
    servers:
    - url: https://api.mepmail.dev
      description: MepMail Cloud
    - url: '{baseUrl}'
      description: Self-hosted instance
      variables:
        baseUrl:
          default: http://localhost:3001
  /webhooks/{id}:
    get:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Webhook, including its signing secret
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWebhookResponse'
              example:
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
                endpoint: https://example.com/webhooks/mepmail
                created_at: '2026-10-19T12:00:00.000Z'
                status: enabled
                events:
                - event
                object: webhook
                signing_secret: signing secret
                previous_secret_expires_at: '2026-10-19T12:00:00.000Z'
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: getWebhook
      summary: Retrieve a webhook
      tags:
      - Webhooks
      description: Returns one webhook, including its signing secret.
    patch:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: id
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWebhookRequest'
            example:
              status: disabled
      responses:
        '200':
          description: Webhook updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookIdResponse'
              example:
                object: webhook
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: updateWebhook
      summary: Update a webhook
      tags:
      - Webhooks
      description: Changes a webhook's endpoint, events or status.
    delete:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Webhook deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoveWebhookResponse'
              example:
                object: webhook
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
                deleted: true
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: deleteWebhook
      summary: Delete a webhook
      tags:
      - Webhooks
      description: Deletes a webhook; nothing is delivered to it afterwards.
    servers:
    - url: https://api.mepmail.dev
      description: MepMail Cloud
    - url: '{baseUrl}'
      description: Self-hosted instance
      variables:
        baseUrl:
          default: http://localhost:3001
  /webhooks/{id}/rotate:
    post:
      summary: Rotate a webhook's signing secret
      description: 'MepMail extension. Mints a new signing secret (or takes the one in signing_secret) and returns it. For overlap_hours the previous secret keeps signing too: every delivery in that window carries both signatures, space-separated in webhook-signature, so the receiver can switch at any point without a gap. A second rotation inside the window replaces the previous secret.'
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: id
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RotateWebhookSecretRequest'
            example:
              overlap_hours: 24
      responses:
        '200':
          description: The new secret and when the previous one stops signing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RotateWebhookSecretResponse'
              example:
                object: webhook
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
                signing_secret: signing secret
                previous_secret_expires_at: '2026-10-19T12:00:00.000Z'
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: rotateWebhookSecret
      tags:
      - Webhooks
    servers:
    - url: https://api.mepmail.dev
      description: MepMail Cloud
    - url: '{baseUrl}'
      description: Self-hosted instance
      variables:
        baseUrl:
          default: http://localhost:3001
components:
  schemas:
    CreateWebhookResponse:
      type: object
      properties:
        object:
          type: string
          enum:
          - webhook
        id:
          type: string
          format: uuid
        signing_secret:
          type: string
      required:
      - object
      - id
      - signing_secret
    CreateWebhookRequest:
      type: object
      properties:
        endpoint:
          type: string
          maxLength: 2048
          format: uri
        events:
          type: array
          items:
            type: string
            enum:
            - email.sent
            - email.delivered
            - email.delivery_delayed
            - email.bounced
            - email.complained
            - email.opened
            - email.clicked
            - email.prefetched
            - deliverability.warning
            - deliverability.paused
            - quota.warning
            - quota.reached
            - quota.paused
            - contact.created
            - contact.updated
            - contact.deleted
            - contact.unsubscribed
            - contact.resubscribed
            - contact.topic_opt_in
            - contact.topic_opt_out
            - suppression.added
            - suppression.removed
            - mailbox.received
          minItems: 1
        signing_secret:
          type: string
          description: 'Signing secret to use instead of minting one: whsec_ followed by base64 of 24-64 bytes, the format Resend/Svix issue. Carry over an existing secret so the receiver keeps verifying unchanged; omit to generate a new one.'
      required:
      - endpoint
      - events
    ErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
        name:
          type: string
        message:
          type: string
      required:
      - statusCode
      - name
      - message
    RotateWebhookSecretResponse:
      type: object
      properties:
        object:
          type: string
          enum:
          - webhook
        id:
          type: string
          format: uuid
        signing_secret:
          type: string
        previous_secret_expires_at:
          type:
          - string
          - 'null'
      required:
      - object
      - id
      - signing_secret
      - previous_secret_expires_at
    RotateWebhookSecretRequest:
      type: object
      properties:
        signing_secret:
          type: string
          description: 'New secret to sign with: whsec_ followed by base64 of 24-64 bytes. Omit to mint one.'
        overlap_hours:
          type: integer
          minimum: 0
          maximum: 72
          description: Hours the previous secret keeps signing alongside the new one (default 24, max 72). Every delivery in the window carries both signatures, so a receiver holding either verifies; 0 drops the old secret at once.
    GetWebhookResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        endpoint:
          type: string
        created_at:
          type: string
        status:
          type: string
          enum:
          - enabled
          - disabled
        events:
          type:
          - array
          - 'null'
          items:
            type: string
        object:
          type: string
          enum:
          - webhook
        signing_secret:
          type: string
        previous_secret_expires_at:
          type:
          - string
          - 'null'
          description: While set, deliveries are also signed with the secret this one replaced (a rotation's overlap window)
      required:
      - id
      - endpoint
      - created_at
      - status
      - events
      - object
      - signing_secret
      - previous_secret_expires_at
    ListWebhooksResponse:
      type: object
      properties:
        object:
          type: string
          enum:
          - list
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              endpoint:
                type: string
              created_at:
                type: string
              status:
                type: string
                enum:
                - enabled
                - disabled
              events:
                type:
                - array
                - 'null'
                items:
                  type: string
            required:
            - id
            - endpoint
            - created_at
            - status
            - events
        has_more:
          type: boolean
      required:
      - object
      - data
      - has_more
    WebhookIdResponse:
      type: object
      properties:
        object:
          type: string
          enum:
          - webhook
        id:
          type: string
          format: uuid
      required:
      - object
      - id
    RemoveWebhookResponse:
      type: object
      properties:
        object:
          type: string
          enum:
          - webhook
        id:
          type: string
          format: uuid
        deleted:
          type: boolean
          enum:
          - true
      required:
      - object
      - id
      - deleted
    UpdateWebhookRequest:
      type: object
      properties:
        endpoint:
          type: string
          maxLength: 2048
          format: uri
        events:
          type: array
          items:
            type: string
            enum:
            - email.sent
            - email.delivered
            - email.delivery_delayed
            - email.bounced
            - email.complained
            - email.opened
            - email.clicked
            - email.prefetched
            - deliverability.warning
            - deliverability.paused
            - quota.warning
            - quota.reached
            - quota.paused
            - contact.created
            - contact.updated
            - contact.deleted
            - contact.unsubscribed
            - contact.resubscribed
            - contact.topic_opt_in
            - contact.topic_opt_out
            - suppression.added
            - suppression.removed
            - mailbox.received
          minItems: 1
        status:
          type: string
          enum:
          - enabled
          - disabled
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'An API key from the dashboard (ms_…), sent as Authorization: Bearer. A sending-only key reaches the /emails routes only.'
x-refined-from:
- docs.json
- mepmail-dev-docs-openapi.json
x-provenance:
  method: harvested
  publisher: MepMail
  source: https://docs.mepmail.dev/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)