Reference
Tech Providers
Provision client orgs, the fan-out webhook and the usage rollup
PARTNER_ADMIN only means something on an org of kind TECH_PROVIDER. See Client orgs.
clientOrgs
Query
ScopePARTNER_ADMIN
Returns
_idString!nameString!slugString!partnerOfStringpartnerRelationPartnerRelationexternalIdStringtenantConnectionTenantConnectionStatusLast known health of the dedicated database/Redis; null when the org uses shared infra
query {
clientOrgs { _id name slug partnerOf partnerRelation }
}clientOrgsPage
Query
ScopePARTNER_ADMIN
Arguments
paginationGetCursorPaginatedInputfilterClientOrgsFilterInputGetCursorPaginatedInput
cursorStringlimitIntbeforeBooleanClientOrgsFilterInput
searchStringReturns
data[Organisation!]!nextCursorStringhasNextBoolean!totalCountIntTotal matching client orgs (only on first page)
query {
clientOrgsPage(pagination: { … }, filter: { … }) { data nextCursor hasNext totalCount }
}createClientOrg
Mutation
ScopePARTNER_ADMIN
Arguments
CreateClientOrgInput
nameString!RequiredslugStringexternalIdStringtenantDbUriStringtenantRedisUrlStringReturns
_idString!nameString!slugString!partnerOfStringpartnerRelationPartnerRelationexternalIdStringtenantConnectionTenantConnectionStatusLast known health of the dedicated database/Redis; null when the org uses shared infra
mutation {
createClientOrg(input: { … }) { _id name slug partnerOf partnerRelation }
}deletePartnerWebhook
Mutationirreversible
ScopePARTNER_ADMIN
Arguments
idID!RequiredReturns
Boolean!mutation {
deletePartnerWebhook(id: "…")
}deprovisionClientOrg
Mutationirreversible
ScopePARTNER_ADMIN
Arguments
orgIdString!RequiredReturns
successBoolean!organisationIdString!deletedCountsCleanupDeletedCounts!errors[String!]!durationInt!Duration in milliseconds
mutation {
deprovisionClientOrg(orgId: "…") { success organisationId deletedCounts errors duration }
}partnerChildUsagePage
Query
ScopePARTNER_ADMIN
Arguments
paginationGetCursorPaginatedInputGetCursorPaginatedInput
cursorStringlimitIntbeforeBooleanTechProviderUsageFilterInput
monthsIntsearchStringReturns
nextCursorStringhasNextBoolean!totalCountIntTotal matching client orgs (only on first page)
query {
partnerChildUsagePage(pagination: { … }, filter: { … }) { data nextCursor hasNext totalCount }
}partnerUsageAllTime
Query
ScopePARTNER_ADMIN
Returns
opsUsedFloat!Ops used across all historical billing periods plus the live current period.
aiUsedFloat!AI units used across all historical billing periods plus the live current period (may be fractional).
estimatedAmountCentsInt!ESTIMATE only: all-time usage x the CURRENT contract rates (gross; ignores included allowances and the monthly minimum). There is no per-charge money log, so past rate changes are not reflected.
query {
partnerUsageAllTime { opsUsed aiUsed estimatedAmountCents }
}partnerUsageHistory
Query
ScopePARTNER_ADMIN
Arguments
TechProviderUsageFilterInput
monthsIntsearchStringReturns
periodEndDateTime!opsUsedFloat!aiUsedFloat!childrenInt!estimatedAmountCentsInt!query {
partnerUsageHistory(filter: { … }) { periodEnd opsUsed aiUsed children estimatedAmountCents }
}partnerUsageSummary
Query
ScopePARTNER_ADMIN
Returns
childrenInt!opsUnitsInt!aiUnitsInt!estimatedAmountCentsInt!currencyString!opsAllowanceRemainingFloat!aiAllowanceRemainingFloat!currentPeriodStartDateTime!currentPeriodEndDateTime!query {
partnerUsageSummary { children opsUnits aiUnits estimatedAmountCents currency }
}partnerWebhookDeliveries
Query
ScopePARTNER_ADMIN
Arguments
Returns
query {
partnerWebhookDeliveries(subscriptionId: "…", status: PENDING, before: { … }, limit: 0, page: 0) { items total nextCursor hasMore }
}partnerWebhooks
Query
ScopePARTNER_ADMIN
Returns
idID!urlString!subscribedEvents[OutboundWebhookEventName!]!statusPartnerWebhookStatus!createdAtDateTimeupdatedAtDateTimequery {
partnerWebhooks { id url subscribedEvents status createdAt }
}registerPartnerWebhook
Mutation
ScopePARTNER_ADMIN
Arguments
urlString!RequiredReturns
mutation {
registerPartnerWebhook(url: "…", events: […]) { id signingSecret }
}rotatePartnerWebhookSecret
Mutation
ScopePARTNER_ADMIN
Arguments
idID!RequiredReturns
signingSecretString!mutation {
rotatePartnerWebhookSecret(id: "…") { signingSecret }
}setPartnerWebhookEvents
Mutation
ScopePARTNER_ADMIN
Arguments
idID!RequiredReturns
idID!urlString!subscribedEvents[OutboundWebhookEventName!]!statusPartnerWebhookStatus!createdAtDateTimeupdatedAtDateTimemutation {
setPartnerWebhookEvents(id: "…", events: […]) { id url subscribedEvents status createdAt }
}setPartnerWebhookStatus
Mutation
ScopePARTNER_ADMIN
Arguments
idID!RequiredReturns
idID!urlString!subscribedEvents[OutboundWebhookEventName!]!statusPartnerWebhookStatus!createdAtDateTimeupdatedAtDateTimemutation {
setPartnerWebhookStatus(id: "…", status: ACTIVE) { id url subscribedEvents status createdAt }
}