Efí Pay (Gerencianet) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gerencianet Webhooks API

16 actions 16 updates phrasing extends openapi/gerencianet-webhooks-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Efí Pay (Gerencianet)'s API. It is a proposal applied on top of the contract, not a document Efí Pay (Gerencianet) publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 16

$.info

$.paths['/webhook'].post

$.paths['/webhook/{identificadorWebhook}'].get

$.paths['/webhook/{identificadorWebhook}'].delete

$.paths['/webhooks'].get

$.paths['/v2/webhook/{chave}'].get

$.paths['/v2/webhook/{chave}'].put

$.paths['/v2/webhook/{chave}'].delete

$.paths['/v2/webhook'].get

$.paths['/v2/webhookrec'].get

$.paths['/v2/webhookrec'].put

$.paths['/v2/webhookrec'].delete

$.paths['/v2/webhookcobr'].get

$.paths['/v2/webhookcobr'].put

$.paths['/v2/webhookcobr'].delete

$.paths['/v2/gn/webhook/reenviar'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Gerencianet Webhooks API
  version: 1.0.0
extends: openapi/gerencianet-webhooks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 15
- target: $.paths['/webhook'].post
  update:
    x-apievangelist-phrasing:
      intent: Register an account webhook
      effect: write
      questions:
      - How do I register a webhook for account events?
      - Can I subscribe a URL to account notifications?
      instructions:
      - text: Configure a new account webhook.
      - text: Register my URL for account event notifications.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhook/{identificadorWebhook}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account webhook
      effect: read
      questions:
      - Can I look up one account webhook by its identifier?
      - Which URL is an account webhook pointing to?
      instructions:
      - text: Show account webhook {identificadorWebhook}.
        slots:
          identificadorWebhook: path.identificadorWebhook
      - text: Get the details of account webhook {identificadorWebhook}.
        slots:
          identificadorWebhook: path.identificadorWebhook
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhook/{identificadorWebhook}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account webhook
      effect: destructive
      questions:
      - Can I remove an account webhook I no longer need?
      - What stops notifications to an account webhook?
      instructions:
      - text: Delete account webhook {identificadorWebhook}.
        slots:
          identificadorWebhook: path.identificadorWebhook
      - text: Remove account webhook {identificadorWebhook}.
        slots:
          identificadorWebhook: path.identificadorWebhook
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List account webhooks
      effect: read
      questions:
      - Which account webhooks have I registered?
      - Can I see all webhooks set up for account events?
      instructions:
      - text: List my account webhooks.
      - text: Show every account event webhook.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/webhook/{chave}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the webhook for a Pix key
      effect: read
      questions:
      - Which webhook URL is set on a given Pix key?
      - Can I check the webhook configured for one of my keys?
      instructions:
      - text: Show the Pix webhook for key {chave}.
        slots:
          chave: path.chave
      - text: Get the webhook URL on Pix key {chave}.
        slots:
          chave: path.chave
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/webhook/{chave}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the webhook for a Pix key
      effect: write
      questions:
      - How do I get notified when a Pix arrives on one of my keys?
      - Can I point a Pix key's notifications at my URL?
      instructions:
      - text: Configure the Pix webhook for key {chave}.
        slots:
          chave: path.chave
      - text: Send Pix notifications for key {chave} to my URL.
        slots:
          chave: path.chave
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/webhook/{chave}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove the webhook from a Pix key
      effect: destructive
      questions:
      - Can I stop Pix notifications for a specific key?
      - What deletes the webhook on a Pix key?
      instructions:
      - text: Delete the Pix webhook on key {chave}.
        slots:
          chave: path.chave
      - text: Stop webhook notifications for Pix key {chave}.
        slots:
          chave: path.chave
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/webhook'].get
  update:
    x-apievangelist-phrasing:
      intent: List Pix key webhooks
      effect: read
      questions:
      - Which of my Pix keys have webhooks configured?
      - Can I see every Pix webhook on my account?
      instructions:
      - text: List my Pix webhooks.
      - text: Show all webhooks set on my Pix keys.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/webhookrec'].get
  update:
    x-apievangelist-phrasing:
      intent: List Pix Automático recurrence webhooks
      effect: read
      questions:
      - Which webhook receives my Pix Automático recurrence events?
      - Can I see the rec webhooks configured?
      instructions:
      - text: List my recurrence webhooks.
      - text: Show the webhook for Pix Automático recurrence events.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/webhookrec'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the Pix Automático recurrence webhook
      effect: write
      questions:
      - How do I get notified when a Pix Automático recurrence changes?
      - Can I register a URL for rec events?
      instructions:
      - text: Configure the recurrence webhook.
      - text: Send Pix Automático recurrence events to my URL.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/webhookrec'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove the Pix Automático recurrence webhook
      effect: destructive
      questions:
      - Can I stop receiving recurrence webhook events?
      - What deletes the rec webhook?
      instructions:
      - text: Delete the recurrence webhook.
      - text: Stop Pix Automático recurrence notifications.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/webhookcobr'].get
  update:
    x-apievangelist-phrasing:
      intent: List Pix Automático charge webhooks
      effect: read
      questions:
      - Which webhook receives my automatic Pix charge events?
      - Can I see the cobr webhooks configured?
      instructions:
      - text: List my automatic charge webhooks.
      - text: Show the webhook for cobr charge events.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/webhookcobr'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the Pix Automático charge webhook
      effect: write
      questions:
      - How do I get notified about automatic Pix charge events?
      - Can I register a URL for cobr events?
      instructions:
      - text: Configure the automatic charge webhook.
      - text: Send cobr charge events to my URL.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/webhookcobr'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove the Pix Automático charge webhook
      effect: destructive
      questions:
      - Can I stop receiving automatic charge webhook events?
      - What deletes the cobr webhook?
      instructions:
      - text: Delete the automatic charge webhook.
      - text: Stop cobr charge notifications.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/gn/webhook/reenviar'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend missed Pix webhooks
      effect: write
      questions:
      - Can I ask for Pix webhook notifications to be sent again?
      - What do I do if my server missed some Pix notifications?
      instructions:
      - text: Resend my Pix webhooks.
      - text: Redeliver Pix notifications my endpoint missed.
      method: generated
      generated: '2026-10-01'