Class WebhookQueryManager

Contains various methods for Photon Webhooks

Hierarchy

WebhookQueryManager

Index

Constructors

Properties

Methods

createWebhook deleteWebhook getWebhooks

Constructors

constructor

new WebhookQueryManager(apollo: ApolloClient<undefined> | ApolloClient<NormalizedCacheObject>): WebhookQueryManager
Parameters
- apollo: ApolloClient<undefined> | ApolloClient<NormalizedCacheObject>
  
  An Apollo client instance
Returns WebhookQueryManager
- Defined in management/webhook.ts:36

Properties

`Private` apollo

apollo: ApolloClient<undefined> | ApolloClient<NormalizedCacheObject>

Methods

createWebhook

createWebhook(options: CreateWebhookOptions): MakeMutationReturn<undefined | null | { createWebhookConfig: WebhookConfig }>
Creates a new webhook for the authenticated organization

Returns
Parameters
- options: CreateWebhookOptions
  
  Query options
Returns MakeMutationReturn<undefined | null | { createWebhookConfig: WebhookConfig }>
- Defined in management/webhook.ts:73

deleteWebhook

deleteWebhook(): MakeMutationReturn<undefined | null | { deleteWebhookConfig: boolean }>
Deletes a webhook, by id, inside the currently authenticated organization

Returns

Returns MakeMutationReturn<undefined | null | { deleteWebhookConfig: boolean }>
- Defined in management/webhook.ts:102

getWebhooks

getWebhooks(options?: GetWebhooksOptions): Promise<MakeQueryReturn<{ webhooks: WebhookConfig[] }>>
Retrieves list of webhook associated with currently authenticated organization

Returns
Parameters
- options: GetWebhooksOptions = ...
  
  Query options
Returns Promise<MakeQueryReturn<{ webhooks: WebhookConfig[] }>>
- Defined in management/webhook.ts:48

Generated using TypeDoc