Returns a single Webhook Subscriber by its ID. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example:
const response = await client.webhookSubscribers.show({
bearer_token: '7381273269536713689562374856'
id: '1'
})
Creates a new Webhook Subscriber and returns its attributes. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example:
const response = await client.webhookSubscribers.create({
bearer_token: '7381273269536713689562374856',
subscriber: {
active: false,
subscriptions: [],
url: 'https://www.url.com/'
}
})
Update selected Webhook Subscriber. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example:
const response = await client.webhookSubscribers.update({
bearer_token: '7381273269536713689562374856',
id: '1',
subscriber: {
active: false,
subscriptions: [],
url: 'https://www.url.com/'
}
})
This endpoint removes the specified Webhook Subscriber. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example:
const response = await client.webhookSubscribers.remove({
bearer_token: '7381273269536713689562374856',
id: '1'
})
Protected
spreeOptional
tokens: ITokenOptional
params: anyOptional
responseParsing: ResponseParsingProtected
classifyProtected
processProtected
processProtected
spreeGenerated using TypeDoc
Returns a list of Webhook Subscribers. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example: