Envia.com · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Envia Webhooks API

6 actions 6 updates phrasing extends openapi/envia-webhooks-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Envia.com's API. It is a proposal applied on top of the contract, not a document Envia.com publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/webhook-types'].get
$.paths['/webhooks'].get
$.paths['/webhooks'].post
$.paths['/webhooks/{webhook_id}'].put
$.paths['/ship/webhooktest/'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Envia Webhooks API
  version: 1.0.0
extends: openapi/envia-webhooks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-20'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/webhook-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook types
      effect: read
      questions:
      - Which event types can I subscribe to for webhooks?
      - What webhook types are available for tracking shipments?
      instructions:
      - text: List all webhook types.
      - text: Show the available webhook event types.
      method: generated
      generated: '2026-11-20'
- target: $.paths['/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List my webhook subscriptions
      effect: read
      questions:
      - Which webhooks are registered under my account?
      - Can I see only the active webhooks?
      instructions:
      - text: List all my webhooks.
      - text: Show only active webhooks.
      method: generated
      generated: '2026-11-20'
- target: $.paths['/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a URL to an event type
      effect: write
      questions:
      - How do I get a webhook sent to my server when a shipment status changes?
      - Can I choose which events a new webhook listens for?
      instructions:
      - text: Create a webhook for type {type_id} sending to {url}, active {active}.
        slots:
          type_id: requestBody.type_id
          url: requestBody.url
          active: requestBody.active
      - text: Subscribe {url} to webhook type {type_id} with active set to {active}.
        slots:
          type_id: requestBody.type_id
          url: requestBody.url
          active: requestBody.active
      method: generated
      generated: '2026-11-20'
- target: $.paths['/webhooks/{webhook_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a webhook's URL or events
      effect: write
      questions:
      - Can I change the URL a webhook posts to?
      - How do I add more events to an existing webhook?
      instructions:
      - text: Update webhook {webhook_id} to post to {url}.
        slots:
          webhook_id: path.webhook_id
          url: requestBody.url
      - text: Change webhook {webhook_id} to listen for events {events}.
        slots:
          webhook_id: path.webhook_id
          events: requestBody.events
      method: generated
      generated: '2026-11-20'
- target: $.paths['/ship/webhooktest/'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a simulated tracking event to webhooks
      effect: write
      questions:
      - How do I test that my webhook URL receives tracking events?
      - Can I simulate a shipment being delivered to my webhook?
      instructions:
      - text: Send a simulated {status} event for tracking number {trackingNumber} on {carrier} to my webhooks.
        slots:
          status: requestBody.status
          trackingNumber: requestBody.trackingNumber
          carrier: requestBody.carrier
      - text: Test my webhook endpoint with a {status} status for {carrier} tracking {trackingNumber}.
        slots:
          status: requestBody.status
          carrier: requestBody.carrier
          trackingNumber: requestBody.trackingNumber
      method: generated
      generated: '2026-11-20'

Work with this as data

Every overlay 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 openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • 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 overlay
curl "https://apis.io/api/v1/overlays/envia-webhooks-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?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.