Execute a GraphQL query over the webhooks API
Execute a GraphQL query or mutation against the Webhooks API, used to manage webhook subscriptions and inspect their delivery history. Available operations include the subscriptions and webhookTypes queries, and the createSubscription, updateSubscription and deleteSubscription mutations. See WebhookType for the list of event types a subscription can be scoped to.
As with any GraphQL endpoint, a request that is successfully parsed and executed always returns 200, with the result under data and, if applicable, a non-empty errors array describing execution failures.
Request
- Base URL: https://api.ebury.io
- URL: https://api.ebury.io/webhooks/graphql
- Auth: API key in header x-api-key
Query parameters
The identifier of a client. Required unless the X-Client-ID header is provided instead.
Headers
The identifier of a client. Alternative to the client_id query parameter. Required unless client_id is provided instead.
The access token.
Request body
Example request
{
"query": "mutation { createSubscription(input: { subscription: { active: true url: \"<your-inbox-url>\" types: [TRADE_STATUS_CHANGE] } }) { subscription { id } } }",
"variables": {}
}Response
Query was executed and the result is in the body
Changes
No recorded changes to this operation across all 1 revision of this API.