Adyen · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Adyen Management Companies API
45 actions
45 updates
phrasing
extends
openapi/adyen-companies-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Adyen's API. It is a proposal applied on top of the contract, not a document Adyen publishes.
What the actions change
x-apievangelist-phrasing
Targets 45 · first 16 shown; the file carries all of them
$.info
$.paths['/companies'].get
$.paths['/companies/{companyId}'].get
$.paths['/companies/{companyId}/androidApps'].get
$.paths['/companies/{companyId}/androidApps'].post
$.paths['/companies/{companyId}/androidApps/{id}'].get
$.paths['/companies/{companyId}/androidCertificates'].get
$.paths['/companies/{companyId}/apiCredentials'].get
$.paths['/companies/{companyId}/apiCredentials'].post
$.paths['/companies/{companyId}/apiCredentials/{apiCredentialId}'].get
$.paths['/companies/{companyId}/apiCredentials/{apiCredentialId}'].patch
$.paths['/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins'].get
$.paths['/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins'].post
$.paths['/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}'].get
$.paths['/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}'].delete
$.paths['/companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKey'].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 Adyen Management Companies API
version: 1.0.0
extends: openapi/adyen-companies-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 44
- target: $.paths['/companies'].get
update:
x-apievangelist-phrasing:
intent: List the company accounts I can access
effect: read
questions:
- Which Adyen company accounts can my API credential see?
- Can I page through company accounts 100 at a time?
instructions:
- text: List all the company accounts my credential has access to.
- text: Show page {page} of my company accounts, {size} per page.
slots:
page: query.pageNumber
size: query.pageSize
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}'].get
update:
x-apievangelist-phrasing:
intent: Get a company account
effect: read
questions:
- What details are stored on one specific company account?
- Can I look up a single company account by its ID?
instructions:
- text: Get the details of company account {company}.
slots:
company: path.companyId
- text: Show me the company account record for {company}.
slots:
company: path.companyId
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/androidApps'].get
update:
x-apievangelist-phrasing:
intent: List Android apps uploaded for a company
effect: read
questions:
- Which Android apps are available to install on my company's payment terminals?
- Can I filter the uploaded terminal apps by package name or version code?
instructions:
- text: List the Android terminal apps uploaded for company {company}.
slots:
company: path.companyId
- text: Find Android apps with package {package} for company {company}.
slots:
company: path.companyId
package: query.packageName
- text: Show version {version} of the Android apps available to company {company}.
slots:
company: path.companyId
version: query.versionCode
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/androidApps'].post
update:
x-apievangelist-phrasing:
intent: Upload an Android app for terminals
effect: write
questions:
- Can I upload my own APK so it can run on Android payment terminals?
- What is the maximum APK size I can upload for terminals?
instructions:
- text: Upload a new Android APK to company {company} for its payment terminals.
slots:
company: path.companyId
- text: Add my terminal app build to company {company} as an APK upload.
slots:
company: path.companyId
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/androidApps/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get one uploaded Android app
effect: read
questions:
- What status and version does one uploaded terminal APK have?
- Can I check the details of a specific Android app I uploaded?
instructions:
- text: Get Android app {app} for company {company}.
slots:
company: path.companyId
app: path.id
- text: Show the details of uploaded terminal app {app} under company {company}.
slots:
company: path.companyId
app: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/androidCertificates'].get
update:
x-apievangelist-phrasing:
intent: List Android certificates for a company
effect: read
questions:
- Which Android certificates are available for running apps on my terminals?
- Can I search the terminal certificates by certificate name?
instructions:
- text: List the Android certificates available to company {company}.
slots:
company: path.companyId
- text: Find Android certificates named {name} for company {company}.
slots:
company: path.companyId
name: query.certificateName
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/apiCredentials'].get
update:
x-apievangelist-phrasing:
intent: List a company's API credentials
effect: read
questions:
- Which API credentials exist for my company account?
- Can I see every API credential under the company, page by page?
instructions:
- text: List the API credentials for company {company}.
slots:
company: path.companyId
- text: Show page {page} of API credentials for company {company}.
slots:
company: path.companyId
page: query.pageNumber
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/apiCredentials'].post
update:
x-apievangelist-phrasing:
intent: Create an API credential for a company
effect: write
questions:
- How do I create a new API credential with limited merchant account access?
- Can I set roles and allowed origins when creating an API credential?
instructions:
- text: Create a new API credential for company {company}.
slots:
company: path.companyId
- text: Create an API credential for company {company} with roles {roles}.
slots:
company: path.companyId
roles: requestBody.roles
- text: Create a company {company} API credential restricted to merchant accounts {merchants}.
slots:
company: path.companyId
merchants: requestBody.associatedMerchantAccounts
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/apiCredentials/{apiCredentialId}'].get
update:
x-apievangelist-phrasing:
intent: Get a company API credential
effect: read
questions:
- What roles and merchant access does a particular API credential have?
- Is a given API credential still active?
instructions:
- text: Get API credential {cred} under company {company}.
slots:
company: path.companyId
cred: path.apiCredentialId
- text: Show roles and access for company {company} credential {cred}.
slots:
company: path.companyId
cred: path.apiCredentialId
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/apiCredentials/{apiCredentialId}'].patch
update:
x-apievangelist-phrasing:
intent: Update a company API credential
effect: write
questions:
- Can I change the roles on an existing API credential?
- How can I deactivate an API credential without deleting it?
instructions:
- text: Change the roles on API credential {cred} in company {company} to {roles}.
slots:
company: path.companyId
cred: path.apiCredentialId
roles: requestBody.roles
- text: Deactivate API credential {cred} in company {company} by setting active to {active}.
slots:
company: path.companyId
cred: path.apiCredentialId
active: requestBody.active
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins'].get
update:
x-apievangelist-phrasing:
intent: List allowed origins on a company credential
effect: read
questions:
- Which domains are allowed to make client-side requests with this API credential?
- Can I see all allowed origins configured on one company API credential?
instructions:
- text: List the allowed origins for API credential {cred} in company {company}.
slots:
company: path.companyId
cred: path.apiCredentialId
- text: Show which domains credential {cred} of company {company} accepts client-side calls from.
slots:
company: path.companyId
cred: path.apiCredentialId
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins'].post
update:
x-apievangelist-phrasing:
intent: Add an allowed origin to a company credential
effect: write
questions:
- How do I allow a new domain to make client-side requests with an API credential?
- Can I add my checkout domain to an existing credential's allowed origins?
instructions:
- text: Add {domain} as an allowed origin on API credential {cred} in company {company}.
slots:
company: path.companyId
cred: path.apiCredentialId
domain: requestBody.domain
- text: Allow client-side requests from {domain} for company {company} credential {cred}.
slots:
company: path.companyId
cred: path.apiCredentialId
domain: requestBody.domain
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}'].get
update:
x-apievangelist-phrasing:
intent: Get one allowed origin of a company credential
effect: read
questions:
- What domain does a specific allowed origin entry hold?
- Can I fetch a single allowed origin by its ID?
instructions:
- text: Get allowed origin {origin} on API credential {cred} in company {company}.
slots:
company: path.companyId
cred: path.apiCredentialId
origin: path.originId
- text: Show the domain stored in origin {origin} for company {company} credential {cred}.
slots:
company: path.companyId
cred: path.apiCredentialId
origin: path.originId
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}'].delete
update:
x-apievangelist-phrasing:
intent: Remove an allowed origin from a company credential
effect: destructive
questions:
- What happens to client-side requests once I remove an allowed origin?
- Can I stop a domain from calling with my company API credential?
instructions:
- text: Remove allowed origin {origin} from API credential {cred} in company {company}.
slots:
company: path.companyId
cred: path.apiCredentialId
origin: path.originId
- text: Delete origin {origin} so company {company} credential {cred} no longer accepts that domain.
slots:
company: path.companyId
cred: path.apiCredentialId
origin: path.originId
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKey'].post
update:
x-apievangelist-phrasing:
intent: Rotate the API key of a company credential
effect: write
questions:
- How long does the old API key keep working after I generate a new one?
- Can I rotate the API key on a company-level credential?
instructions:
- text: Generate a new API key for credential {cred} in company {company}.
slots:
company: path.companyId
cred: path.apiCredentialId
- text: Rotate the API key of company {company} API credential {cred}.
slots:
company: path.companyId
cred: path.apiCredentialId
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/apiCredentials/{apiCredentialId}/generateClientKey'].post
update:
x-apievangelist-phrasing:
intent: Rotate the client key of a company credential
effect: write
questions:
- Can I generate a fresh client key for a company API credential?
- When does the previous client key stop working after rotation?
instructions:
- text: Generate a new client key for credential {cred} in company {company}.
slots:
company: path.companyId
cred: path.apiCredentialId
- text: Replace the client key on company {company} API credential {cred}.
slots:
company: path.companyId
cred: path.apiCredentialId
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/billingEntities'].get
update:
x-apievangelist-phrasing:
intent: List billing entities for terminal orders
effect: read
questions:
- Which billing entities can I charge a terminal order to?
- Can I find a billing entity by name before placing an order?
instructions:
- text: List the billing entities for company {company}.
slots:
company: path.companyId
- text: Find the billing entity named {name} in company {company}.
slots:
company: path.companyId
name: query.name
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/merchants'].get
update:
x-apievangelist-phrasing:
intent: List a company's merchant accounts
effect: read
questions:
- Which merchant accounts sit under my company account?
- Does the merchant list only show accounts my credential can access?
instructions:
- text: List the merchant accounts under company {company}.
slots:
company: path.companyId
- text: Show page {page} of merchant accounts for company {company}, {size} per page.
slots:
company: path.companyId
page: query.pageNumber
size: query.pageSize
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/shippingLocations'].get
update:
x-apievangelist-phrasing:
intent: List shipping locations for terminal orders
effect: read
questions:
- Where can my terminal orders be delivered?
- Can I look up a shipping location by name to get its ID?
instructions:
- text: List the shipping locations for company {company}.
slots:
company: path.companyId
- text: Find the shipping location named {name} in company {company}.
slots:
company: path.companyId
name: query.name
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/shippingLocations'].post
update:
x-apievangelist-phrasing:
intent: Create a shipping location for orders
effect: write
questions:
- Can I add a new delivery address for terminal orders?
- What do I need to set up a shipping location for my company?
instructions:
- text: Create a shipping location called {name} for company {company}.
slots:
company: path.companyId
name: requestBody.name
- text: Add a delivery address {address} named {name} to company {company}.
slots:
company: path.companyId
name: requestBody.name
address: requestBody.address
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/terminalActions'].get
update:
x-apievangelist-phrasing:
intent: List scheduled terminal actions
effect: read
questions:
- Which terminal actions have I scheduled across the company, like app installs?
- Can I see only the terminal actions that failed?
instructions:
- text: List the terminal actions scheduled for company {company}.
slots:
company: path.companyId
- text: Show {status} terminal actions for company {company}.
slots:
company: path.companyId
status: query.status
- text: List {type} actions scheduled on company {company} terminals.
slots:
company: path.companyId
type: query.type
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/terminalActions/{actionId}'].get
update:
x-apievangelist-phrasing:
intent: Get one scheduled terminal action
effect: read
questions:
- What is the status of a specific terminal action I scheduled?
- Did a particular app install action on my terminals succeed?
instructions:
- text: Get terminal action {action} for company {company}.
slots:
company: path.companyId
action: path.actionId
- text: Check the result of action {action} scheduled for company {company} terminals.
slots:
company: path.companyId
action: path.actionId
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/terminalLogos'].get
update:
x-apievangelist-phrasing:
intent: Get the company-level terminal logo
effect: read
questions:
- What logo do my company's terminals of a given model display?
- Is the company terminal logo returned as a Base64 image?
instructions:
- text: Get the company {company} logo for terminal model {model}.
slots:
company: path.companyId
model: query.model
- text: Show the logo configured company-wide on {model} terminals for {company}.
slots:
company: path.companyId
model: query.model
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/terminalLogos'].patch
update:
x-apievangelist-phrasing:
intent: Change the company-level terminal logo
effect: write
questions:
- Can I change the logo on every terminal of one model across my company?
- Can I update logos for more than one terminal model in a single request?
instructions:
- text: Set the company {company} logo for {model} terminals to {data}.
slots:
company: path.companyId
model: query.model
data: requestBody.data
- text: Replace the company-wide logo on model {model} terminals for company {company}.
slots:
company: path.companyId
model: query.model
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/terminalModels'].get
update:
x-apievangelist-phrasing:
intent: List terminal models a company can use
effect: read
questions:
- Which payment terminal models does my company have access to?
- Where do I get the terminal model ID used to filter terminals?
instructions:
- text: List the terminal models available to company {company}.
slots:
company: path.companyId
- text: Show company {company}'s terminal model IDs.
slots:
company: path.companyId
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/terminalOrders'].get
update:
x-apievangelist-phrasing:
intent: List terminal product orders
effect: read
questions:
- Which terminal orders has my company placed?
- Can I filter terminal orders by status or my own purchase order reference?
instructions:
- text: List the terminal orders for company {company}.
slots:
company: path.companyId
- text: Show company {company} terminal orders with status {status}.
slots:
company: path.companyId
status: query.status
- text: Find the terminal order with purchase reference {ref} in company {company}.
slots:
company: path.companyId
ref: query.customerOrderReference
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/terminalOrders'].post
update:
x-apievangelist-phrasing:
intent: Order payment terminal products
effect: write
questions:
- How do I order new payment terminals for my company?
- Does ordering terminals through the test environment ship real devices?
instructions:
- text: Order terminal products {items} for company {company}, billed to {billing} and shipped to {location}.
slots:
company: path.companyId
items: requestBody.items
billing: requestBody.billingEntityId
location: requestBody.shippingLocationId
- text: Place a terminal order for company {company} with purchase reference {ref}.
slots:
company: path.companyId
ref: requestBody.customerOrderReference
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/terminalOrders/{orderId}'].get
update:
x-apievangelist-phrasing:
intent: Get a terminal product order
effect: read
questions:
- What is the status of a terminal order I placed?
- Can I see which products and shipping location are on one order?
instructions:
- text: Get terminal order {order} for company {company}.
slots:
company: path.companyId
order: path.orderId
- text: Check where company {company} terminal order {order} stands.
slots:
company: path.companyId
order: path.orderId
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/terminalOrders/{orderId}'].patch
update:
x-apievangelist-phrasing:
intent: Change a placed terminal order
effect: write
questions:
- Can I change the products on a terminal order after placing it?
- Until when can a terminal order still be edited?
instructions:
- text: Update the items on terminal order {order} in company {company} to {items}.
slots:
company: path.companyId
order: path.orderId
items: requestBody.items
- text: Change the shipping location of company {company} order {order} to {location}.
slots:
company: path.companyId
order: path.orderId
location: requestBody.shippingLocationId
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/terminalOrders/{orderId}/cancel'].post
update:
x-apievangelist-phrasing:
intent: Cancel a terminal product order
effect: destructive
questions:
- Can I cancel a terminal order that has already shipped?
- What status must a terminal order be in before I can cancel it?
instructions:
- text: Cancel terminal order {order} for company {company}.
slots:
company: path.companyId
order: path.orderId
- text: Call off company {company}'s placed terminal order {order}.
slots:
company: path.companyId
order: path.orderId
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/terminalProducts'].get
update:
x-apievangelist-phrasing:
intent: List terminal products available by country
effect: read
questions:
- Which terminal packages and parts can I order in a given country?
- Can I see only the products for one terminal model?
instructions:
- text: List the terminal products company {company} can order in {country}.
slots:
company: path.companyId
country: query.country
- text: Show {country} products for terminal model {model} available to company {company}.
slots:
company: path.companyId
country: query.country
model: query.terminalModelId
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/terminalSettings'].get
update:
x-apievangelist-phrasing:
intent: Get company-wide terminal settings
effect: read
questions:
- What terminal settings apply to all terminals across my company?
- Which receipt, tipping and connectivity defaults are set at the company level?
instructions:
- text: Get the company-level terminal settings for {company}.
slots:
company: path.companyId
- text: Show the default terminal configuration applied across company {company}.
slots:
company: path.companyId
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/terminalSettings'].patch
update:
x-apievangelist-phrasing:
intent: Update company-wide terminal settings
effect: write
questions:
- Can I enable tipping on every terminal in my company at once?
- Do company terminal settings override values set on a store or merchant?
instructions:
- text: Update the gratuity settings for all terminals in company {company} to {gratuities}.
slots:
company: path.companyId
gratuities: requestBody.gratuities
- text: Change the company {company} terminal receipt options to {options}.
slots:
company: path.companyId
options: requestBody.receiptOptions
- text: Set the Wi-Fi profiles for company {company} terminals to {wifi}.
slots:
company: path.companyId
wifi: requestBody.wifiProfiles
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/users'].get
update:
x-apievangelist-phrasing:
intent: List a company's Customer Area users
effect: read
questions:
- Who are the users on my company account?
- Can I search company users by username?
instructions:
- text: List the users of company {company}.
slots:
company: path.companyId
- text: Find the user with username {username} in company {company}.
slots:
company: path.companyId
username: query.username
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/users'].post
update:
x-apievangelist-phrasing:
intent: Create a company user
effect: write
questions:
- How do I add a new team member to my company account?
- Can I give a new user access to only certain merchant accounts?
instructions:
- text: Create user {username} named {name} with email {email} in company {company}.
slots:
company: path.companyId
username: requestBody.username
name: requestBody.name
email: requestBody.email
- text: Add user {username} ({email}) to company {company} with roles {roles}.
slots:
company: path.companyId
username: requestBody.username
email: requestBody.email
roles: requestBody.roles
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/users/{userId}'].get
update:
x-apievangelist-phrasing:
intent: Get a company user's details
effect: read
questions:
- What roles and merchant access does one company user have?
- Can I look up a company user by their user ID?
instructions:
- text: Get user {user} in company {company}.
slots:
company: path.companyId
user: path.userId
- text: Show the roles and email of company {company} user {user}.
slots:
company: path.companyId
user: path.userId
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/users/{userId}'].patch
update:
x-apievangelist-phrasing:
intent: Update a company user
effect: write
questions:
- Can I deactivate a company user who left the team?
- Can I change a company user's roles or email?
instructions:
- text: Change the roles of user {user} in company {company} to {roles}.
slots:
company: path.companyId
user: path.userId
roles: requestBody.roles
- text: Deactivate company {company} user {user} by setting active to {active}.
slots:
company: path.companyId
user: path.userId
active: requestBody.active
- text: Update the email of user {user} in company {company} to {email}.
slots:
company: path.companyId
user: path.userId
email: requestBody.email
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/webhooks'].get
update:
x-apievangelist-phrasing:
intent: List a company's webhooks
effect: read
questions:
- Which webhooks are configured at the company level?
- Can I page through all company webhook configurations?
instructions:
- text: List the webhooks configured for company {company}.
slots:
company: path.companyId
- text: Show page {page} of company {company}'s webhook configurations.
slots:
company: path.companyId
page: query.pageNumber
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/webhooks'].post
update:
x-apievangelist-phrasing:
intent: Set up a company webhook
effect: write
questions:
- How do I subscribe to event notifications for my whole company account?
- Can I protect a company webhook with basic authentication?
instructions:
- text: Set up a {type} webhook for company {company} that posts to {url}.
slots:
company: path.companyId
type: requestBody.type
url: requestBody.url
- text: Create a company {company} webhook to {url} in {format} format for merchant accounts {merchants}.
slots:
company: path.companyId
url: requestBody.url
format: requestBody.communicationFormat
merchants: requestBody.filterMerchantAccounts
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/webhooks/{webhookId}'].get
update:
x-apievangelist-phrasing:
intent: Get a company webhook configuration
effect: read
questions:
- What URL and event types is a company webhook configured with?
- Is a particular company webhook currently active?
instructions:
- text: Get webhook {webhook} for company {company}.
slots:
company: path.companyId
webhook: path.webhookId
- text: Show the configuration of company {company} webhook {webhook}.
slots:
company: path.companyId
webhook: path.webhookId
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/webhooks/{webhookId}'].delete
update:
x-apievangelist-phrasing:
intent: Remove a company webhook
effect: destructive
questions:
- Can I delete a company webhook I no longer use?
- What happens to notifications after I remove a company webhook?
instructions:
- text: Remove webhook {webhook} from company {company}.
slots:
company: path.companyId
webhook: path.webhookId
- text: Delete company {company}'s webhook configuration {webhook}.
slots:
company: path.companyId
webhook: path.webhookId
method: generated
generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/webhooks/{webhookId}'].patch
update:
x-apievangelist-phrasing:
intent: Update a company webhook
effect: write
questions:
- Can I change the endpoint URL of an existing company webhook?
- Can I switch a company webhook off temporarily?
instructions:
- text: Change the URL of webhook {webhook} in company {company} to {url}.
slots:
company: path.companyId
webhook: path.webhookId
url: requestBody.url
- text: Set company {company} webhook {webhook} active to {active}.
slots:
company: path.companyId
webhook: path.webhookId
active: requestBody.active
method: generated
generated: '2026-09-26'
# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/overlays/adyen-companies-api-phrasing-overlay.yaml