Hatch · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Hatch

4 actions 4 updates documentation extends openapi/hatch-openapi-original.json
Authorship not recorded No authorship marker is recorded for this file. It is not presented as the provider's.
View Overlay File View on GitHub Overlay Specification

What the actions change

descriptionx-apievangelist-enrichmentnameurl

Targets 4

$.info
$.info.contact
$.info.x-rate-limit
$.servers[0]

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Hatch
  version: 1.0.0
extends: openapi/hatch-openapi-original.json
actions:
- target: $.info
  update:
    description: >-
      Hatch public REST API. The primary operation upserts a contact into a
      Hatch campaign for AI-driven voice, SMS, and email outreach. Contacts are
      deduplicated on phoneNumber, then email, then externalID. Authentication is
      an HTTP bearer token (API key) managed in the App Marketplace. Rate limit:
      100 requests per 10 seconds.
    x-apievangelist-enrichment:
      authentication: authentication/hatch-authentication.yml
      conventions: conventions/hatch-conventions.yml
      errors: errors/hatch-problem-types.yml
      webhooks: asyncapi/hatch-webhooks.yml
      rate_limits: rate-limits/hatch-rate-limits.yml
      data_model: data-model/hatch-data-model.yml
- target: $.info.contact
  update:
    name: Hatch API Support
    url: https://docs.usehatchapp.com/integrations/hatch-api/hatch-api-reference
- target: $.info.x-rate-limit
  update:
    description: 100 requests per 10 seconds
- target: $.servers[0]
  update:
    description: Hatch production API host