| Methods |
public
|
listSubscription(
array $queryParameters = [],
string $fetch = self::FETCH_OBJECT,
): PageWebhookSubscription|ResponseInterface|null
List the webhooks you have registered.
List the webhooks you have registered.
Parameters
| $queryParameters |
{
|
| $fetch |
Fetch mode to use (can be OBJECT or RESPONSE)
|
Throws
|
#
|
public
|
createSubscription(
CreateWebhookSubscriptionRequest $requestBody,
array $headerParameters = [],
string $fetch = self::FETCH_OBJECT,
): WebhookSubscription|ResponseInterface|null
Register an endpoint to start receiving selected webhook events.
Register an endpoint to start receiving selected webhook events.
Parameters
| $headerParameters |
{
|
| $fetch |
Fetch mode to use (can be OBJECT or RESPONSE)
|
Throws
|
#
|
public
|
listSecrets(string $fetch = self::FETCH_OBJECT): WebhookSecret[]|ResponseInterface|null
Parameters
| $fetch |
Fetch mode to use (can be OBJECT or RESPONSE)
|
Throws
|
#
|
public
|
deleteSubscription(string $id, string $fetch = self::FETCH_OBJECT): ResponseInterface|null
Unregister a webhook if you want to stop receiving webhook events.
Unregister a webhook if you want to stop receiving webhook events.
Parameters
| $fetch |
Fetch mode to use (can be OBJECT or RESPONSE)
|
Throws
|
#
|
public
|
getSubscriptionById(string $id, string $fetch = self::FETCH_OBJECT): WebhookSubscription|ResponseInterface|null
Get details of a webhook.
Get details of a webhook.
Parameters
| $fetch |
Fetch mode to use (can be OBJECT or RESPONSE)
|
Throws
|
#
|
public
|
updateSubscription(
string $id,
UpdateWebhookSubscriptionRequest $requestBody,
string $fetch = self::FETCH_OBJECT,
): WebhookSubscription|ResponseInterface|null
Update a webhook.
Parameters
| $fetch |
Fetch mode to use (can be OBJECT or RESPONSE)
|
Throws
|
#
|
public
static
|
create($httpClient = null, array $additionalPlugins = [], array $additionalNormalizers = [])
|
#
|