Catalogue / External

Third-party API

externalthird-party-api

A service outside your control that you call.

Category
External
Properties
7
Components
109
Rules
0
Properties · 7 defined by this kind

A node of this kind resolves each property from its own props, then the component's defaults, then the default below.

propertytypevaluesrequireddefault
callbackStyleenumnone | webhook | pollnonone
handlesMoneyboolean—nofalse
hostedPageboolean—nofalse
idempotentboolean—no—
managedboolean—nofalse
qpsQuotainteger—no—
slaPercentstring—no—
Rules for this kind · 0
No rule selects this kind or its category. Governance calls that a recorded gap.
Components · 109
default
Adyenadyen4 defaultsAmazon Payamazon-pay4 defaultsApifyapify4 defaultsApple Push Notification serviceapns2 defaultsBank APIbank-api3 defaultsBirdbird3 defaultsBraintreebraintree5 defaultsBrave Search APIbrave-search-api6 defaultsBrowserbasebrowserbase4 defaultsCard networkcard-network3 defaultsCheckout.comcheckout-com4 defaultsDiscord APIdiscord5 defaultsExaexa-ai6 defaultsFacebook Graph APIfacebook3 defaultsFirecrawlfirecrawl4 defaultsGeoServergeoserver5 defaultsHERE Location Serviceshere6 defaultsHubSpot APIhubspot5 defaultsHyperbrowserhyperbrowser4 defaultsIntercomintercom4 defaultsLet's Encryptlets-encrypt4 defaultsLINE Messaging APIline4 defaultsMailgunmailgun4 defaultsMailchimp Transactional (Mandrill)mandrill3 defaultsMapboxmapbox5 defaultsMaps APImaps-api2 defaultsMessenger Platformmessenger4 defaultsMicrosoft Teamsmicrosoft-teams5 defaultsMolliemollie5 defaultsmParticlemparticle4 defaultsNominatimnominatim5 defaultsPayment service providerpayment-service-provider3 defaultsPayPalpaypal5 defaultsPayUpayu5 defaultsPlaidplaid3 defaultsPlivo Messagingplivo4 defaultsPostfixpostfix3 defaultsPostmarkpostmark3 defaultsRazorpayrazorpay5 defaultsResendresend4 defaultsSalesforce APIsalesforce5 defaultsScrapingBeescrapingbee5 defaultsTwilio Segmentsegment6 defaultsSendGridsendgrid2 defaultsSerpApiserpapi5 defaultsSerperserper5 defaultsShopify APIshopify4 defaultsSlack APIslack3 defaultsSMTP relaysmtp-relay2 defaultsSMTP serversmtp-server2 defaultsSquaresquare4 defaultsSteelsteel-dev4 defaultsStripestripe5 defaultsSupplier APIsupplier-api1 defaultsTavilytavily5 defaultsTelegram Bot APItelegram4 defaultsTileServer GLtileserver-gl5 defaultsTwilio SMStwilio-sms2 defaultsVonage Messages APIvonage4 defaultsWindows Push Notification Servicewns5 defaultsWorldpayworldpay4 defaultsX APIx-api4 defaultsYou.com APIsyou-com-api6 defaultsZendesk APIzendesk5 defaults
Source
# yaml-language-server: $schema=../schema/kind.schema.json
# A service outside your control that you call: PSPs, banks, push providers, suppliers, exchanges.
# idempotent is optional with no default so money rules can catch the missing declaration.
schemaVersion: "1"
type: "kind"
id: "third-party-api"
category: "external"
properties:
  idempotent:
    type: "boolean"
  qpsQuota:
    type: "integer"
  callbackStyle:
    type: "enum"
    values: ["none", "webhook", "poll"]
    default: "none"
  hostedPage:
    type: "boolean"
    default: false
  slaPercent:
    type: "string"
  handlesMoney:
    type: "boolean"
    default: false
  managed:
    type: "boolean"
    default: false

The same page as markdown, for an agent: /catalogue/kinds/third-party-api.md