Friendbuy · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Friendbuy Merchant Events API

6 actions 6 updates update extends openapi/friendbuy-events-api-openapi.yml
Derived by API Evangelist Built from the contracts Friendbuy publishes. Friendbuy did not publish this file.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-idempotencyx-apievangelist-providerx-apievangelist-artifactsx-agent-notesx-lifecyclex-error-envelope

Targets 5

$.info
$.components.schemas.Error
$.paths['/postPurchaseEvent'].post
$.paths['/postSignUpEvent'].post
$.paths['/postCustomEvent'].post

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Friendbuy Merchant Events API
  version: 1.0.0
extends: openapi/friendbuy-events-api-openapi.yml
x-generated: '2026-08-13'
x-method: generated
x-source: >-
  Enhancements derived from the API Evangelist artifacts in this repository
  (conventions/, errors/, asyncapi/, lifecycle/, authentication/,
  data-model/, rate-limits/), themselves read from
  https://developers.friendbuy.com. This overlay is never applied to the
  source document; it records what API Evangelist knows that the
  specification does not carry.
actions:
- target: $.info
  update:
    x-apievangelist-provider: friendbuy
    x-apievangelist-artifacts:
      conventions: conventions/friendbuy-conventions.yml
      errors: errors/friendbuy-problem-types.yml
      webhooks: asyncapi/friendbuy-webhooks.yml
      lifecycle: lifecycle/friendbuy-lifecycle.yml
      authentication: authentication/friendbuy-authentication.yml
      data_model: data-model/friendbuy-data-model.yml
      rate_limits: rate-limits/friendbuy-rate-limits.yml
    x-agent-notes:
      idempotency: >-
        Not supported. Friendbuy documents no idempotency key for any write
        operation, so a blind retry can double-count a conversion or
        double-credit a loyalty ledger.
      credentials: >-
        Account key and secret are issued by Friendbuy (Developer Center in
        the Retailer App). There is no self-serve signup, no sandbox and no
        test-mode key prefix.
- target: $.info
  update:
    x-lifecycle:
      versioning: uri-path
      current: v1
      status_page: https://friendbuy.statuspage.io
      deprecation_policy: null
- target: $.components.schemas.Error
  update:
    x-error-envelope:
      rfc9457: false
      properties: [error, message, code, reference]
      statuses: [400, 401, 404, 422, 429, 500]
      note: >-
        Flat proprietary envelope, confirmed live against https://mapi.fbot.me
        on 2026-08-13. `reference` is the value to quote to Friendbuy support.
- target: $.paths['/postPurchaseEvent'].post
  update:
    x-idempotency:
      supported: false
      note: >-
        No idempotency key is documented. Retrying this call after an
        ambiguous failure may duplicate its effect.
- target: $.paths['/postSignUpEvent'].post
  update:
    x-idempotency:
      supported: false
      note: >-
        No idempotency key is documented. Retrying this call after an
        ambiguous failure may duplicate its effect.
- target: $.paths['/postCustomEvent'].post
  update:
    x-idempotency:
      supported: false
      note: >-
        No idempotency key is documented. Retrying this call after an
        ambiguous failure may duplicate its effect.

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/friendbuy-events-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. See our Privacy Policy and Terms.

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