Webhooks

SDK Reference · Resource

Webhooks

Configure customer webhook destinations and delivery behaviour.

list()create()get()delete()

method

list()

List customer webhooks

Returns webhook destinations configured by the authenticated account, including delivery timeouts and retry settings.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.webhooks.list(options: WebhooksListOptions = {}): Promise<WebhooksListResponse>

Parameters

Name	Type	Requirement	Description
limit	number	Optional	Number of results to return per page.
offset	number	Optional	The initial index from which to return the results.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.webhooks.list();

Returns

PaginatedWebhookListList

The operation completed successfully.

typePaginatedWebhookListList4fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Optional

—

previous

string

Optional

—

results

WebhookList[]

Required

—

typeWebhookList8fields

FieldTypeRequirementDescription

id

string

Optional

—

type

WebhookScopeEnum

Optional

Context in which this webhook operates. Determines which events are delivered. User events scoped to the associated user account Reseller events scoped to the reseller and their sub-accounts System platform-wide system events * `user` - User * `reseller` - Reseller * `system` - System

enumWebhookScopeEnum0fields

* `user` - User * `reseller` - Reseller * `system` - System

No fields.

endpoint

string

Required

HTTPS URL that receives webhook POST requests when events are triggered. https://example.com/webhooks/proxy The endpoint must be publicly accessible and respond within the configured read timeout.

read_timeout

number

Optional

Maximum time to wait for the endpoint to return a response. Requests that exceed this limit are treated as failed and may be retried.

write_timeout

number

Optional

Maximum time to wait while sending the payload to the endpoint. Requests that exceed this limit are treated as failed and may be retried.

retries

number

Optional

Number of additional delivery attempts after an initial failure. Set to 0 to disable retries. 3 → up to 4 total delivery attempts

retry_timeout

number

Optional

How long to wait before each retry attempt after a failed delivery. 10 → retry after 10 seconds

created

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.webhooks.listWithResponse(options): Promise<ApiResponse<WebhooksListResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.webhooks.list(*, limit: int | Unset=UNSET, offset: int | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedWebhookList

Asyncawait async_client.webhooks.list(*, limit: int | Unset=UNSET, offset: int | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedWebhookList

Parameters

Name	Type	Requirement	Description
limit	int	Optional	Number of results to return per page.
offset	int	Optional	The initial index from which to return the results.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.webhooks.list()

Async example

result = await async_client.webhooks.list()

Returns

PaginatedWebhookList

The operation completed successfully.

classPaginatedWebhookList4fields

FieldTypeRequirementDescription

count

int

Required

—

results

list[WebhookList]

Required

—

classWebhookList8fields

FieldTypeRequirementDescription

endpoint

str

Required

HTTPS URL that receives webhook POST requests when events are triggered. https://example.com/webhooks/proxy The endpoint must be publicly accessible and respond within the configured read timeout.

created

datetime.datetime

Required

—

id

str

Optional

—

type_

WebhookScopeEnum

Optional

* `user` - User * `reseller` - Reseller * `system` - System

enumWebhookScopeEnum0fields

No fields.

read_timeout

int

Optional

Maximum time to wait for the endpoint to return a response. Requests that exceed this limit are treated as failed and may be retried.

write_timeout

int

Optional

Maximum time to wait while sending the payload to the endpoint. Requests that exceed this limit are treated as failed and may be retried.

retries

int

Optional

Number of additional delivery attempts after an initial failure. Set to 0 to disable retries. 3 → up to 4 total delivery attempts

retry_timeout

int

Optional

How long to wait before each retry attempt after a failed delivery. 10 → retry after 10 seconds

next_

None | str

Optional

—

previous

None | str

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.webhooks.list_with_response(*, limit: int | Unset=UNSET, offset: int | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[PaginatedWebhookList]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->webhooks()->list($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

Parameters

Name	Type	Requirement	Description
limit	int	Optional	Number of results to return per page.
offset	int	Optional	The initial index from which to return the results.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->webhooks()->list();

Returns

PaginatedWebhookList

The operation completed successfully.

classPaginatedWebhookList4fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

| [optional]

previous

string

Required

| [optional]

results

[WebhookList[]](WebhookList.md)

Required

|

classWebhookList8fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

type

WebhookScopeEnum

Optional

Context in which this webhook operates. Determines which events are delivered. User events scoped to the associated user account Reseller events scoped to the reseller and their sub-accounts System platform-wide system events * `user` - User * `reseller` - Reseller * `system` - System

enumWebhookScopeEnum0fields

* `user` - User * `reseller` - Reseller * `system` - System

No fields.

endpoint

string

Required

HTTPS URL that receives webhook POST requests when events are triggered. https://example.com/webhooks/proxy The endpoint must be publicly accessible and respond within the configured read timeout. |

readTimeout

int

Optional

Maximum time to wait for the endpoint to return a response. Requests that exceed this limit are treated as failed and may be retried.

writeTimeout

int

Optional

Maximum time to wait while sending the payload to the endpoint. Requests that exceed this limit are treated as failed and may be retried.

retries

int

Optional

Number of additional delivery attempts after an initial failure. Set to 0 to disable retries. 3 → up to 4 total delivery attempts

retryTimeout

int

Optional

How long to wait before each retry attempt after a failed delivery. 10 → retry after 10 seconds

created

DateTime

Required

| [readonly]

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->webhooks()->listWithResponse($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->webhooks()->listWithHttpInfo($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns the OpenAPI Generator response tuple.

• $client->webhooks()->listAsync($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns a Guzzle promise for the decoded result.

• $client->webhooks()->listAsyncWithHttpInfo($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns a Guzzle promise for the response tuple.

• $client->webhooks()->listRequest($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Builds the PSR-7 request without sending it.

method

create()

Create a customer webhook

Registers an HTTPS destination for a supported event type. Private, loopback, and otherwise unsafe destinations are rejected.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.webhooks.create(options: WebhooksCreateOptions): Promise<WebhooksCreateResponse>

Parameters

Name	Type	Requirement	Description
idempotencyKey	string	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	WebhookCreateRequest	Required	—

Example

const result = await client.webhooks.create({
  body: {
    "type": "user",
    "endpoint": "{endpoint}"
  }
});

Returns

WebhookCreated

The resource or action result was created successfully.

typeWebhookCreated9fields

FieldTypeRequirementDescription

id

string

Optional

—

type

WebhookScopeEnum

Optional

Context in which this webhook operates. Determines which events are delivered. User events scoped to the associated user account Reseller events scoped to the reseller and their sub-accounts System platform-wide system events * `user` - User * `reseller` - Reseller * `system` - System

enumWebhookScopeEnum0fields

* `user` - User * `reseller` - Reseller * `system` - System

No fields.

endpoint

string

Required

HTTPS URL that receives webhook POST requests when events are triggered. https://example.com/webhooks/proxy The endpoint must be publicly accessible and respond within the configured read timeout.

secret

string

Optional

Secret used to sign each webhook payload. The receiving endpoint should verify the signature to confirm the request originated from this platform. Auto-generated if left blank. Store this value securely on the receiving end.

read_timeout

number

Optional

Maximum time to wait for the endpoint to return a response. Requests that exceed this limit are treated as failed and may be retried.

write_timeout

number

Optional

Maximum time to wait while sending the payload to the endpoint. Requests that exceed this limit are treated as failed and may be retried.

retries

number

Optional

Number of additional delivery attempts after an initial failure. Set to 0 to disable retries. 3 → up to 4 total delivery attempts

retry_timeout

number

Optional

How long to wait before each retry attempt after a failed delivery. 10 → retry after 10 seconds

created

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "conflict"The operation conflicts with the current resource or idempotency state.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.webhooks.createWithResponse(options): Promise<ApiResponse<WebhooksCreateResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.webhooks.create(*, body: WebhookCreateRequest, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> WebhookCreated

Asyncawait async_client.webhooks.create(*, body: WebhookCreateRequest, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> WebhookCreated

Parameters

Name	Type	Requirement	Description
idempotency_key	str	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	WebhookCreateRequest	Required	—

Example

result = client.webhooks.create(
        body=models.WebhookCreateRequest.from_dict({'type': 'user', 'endpoint': '{endpoint}'}),
    )

Async example

result = await async_client.webhooks.create(
        body=models.WebhookCreateRequest.from_dict({'type': 'user', 'endpoint': '{endpoint}'}),
    )

Returns

WebhookCreated

The resource or action result was created successfully.

classWebhookCreated9fields

FieldTypeRequirementDescription

endpoint

str

Required

HTTPS URL that receives webhook POST requests when events are triggered. https://example.com/webhooks/proxy The endpoint must be publicly accessible and respond within the configured read timeout.

created

datetime.datetime

Required

—

id

str

Optional

—

type_

WebhookScopeEnum

Optional

* `user` - User * `reseller` - Reseller * `system` - System

enumWebhookScopeEnum0fields

No fields.

secret

str

Optional

Secret used to sign each webhook payload. The receiving endpoint should verify the signature to confirm the request originated from this platform. Auto-generated if left blank. Store this value securely on the receiving end.

read_timeout

int

Optional

Maximum time to wait for the endpoint to return a response. Requests that exceed this limit are treated as failed and may be retried.

write_timeout

int

Optional

Maximum time to wait while sending the payload to the endpoint. Requests that exceed this limit are treated as failed and may be retried.

retries

int

Optional

Number of additional delivery attempts after an initial failure. Set to 0 to disable retries. 3 → up to 4 total delivery attempts

retry_timeout

int

Optional

How long to wait before each retry attempt after a failed delivery. 10 → retry after 10 seconds

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.CONFLICTThe operation conflicts with the current resource or idempotency state.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.webhooks.create_with_response(*, body: WebhookCreateRequest, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[WebhookCreated]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->webhooks()->create($webhookCreateRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['create'][0])

Parameters

Name	Type	Requirement	Description
idempotencyKey	string	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
webhookCreateRequest	WebhookCreateRequest	Required	—

Example

$result = $client->webhooks()->create(
    webhookCreateRequest: new Dto\WebhookCreateRequest([
        'type' => 'user',
        'endpoint' => '{endpoint}',
    ]),
);

Returns

WebhookCreated

The resource or action result was created successfully.

classWebhookCreated9fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

type

WebhookScopeEnum

Optional

Context in which this webhook operates. Determines which events are delivered. User events scoped to the associated user account Reseller events scoped to the reseller and their sub-accounts System platform-wide system events * `user` - User * `reseller` - Reseller * `system` - System

enumWebhookScopeEnum0fields

* `user` - User * `reseller` - Reseller * `system` - System

No fields.

endpoint

string

Required

HTTPS URL that receives webhook POST requests when events are triggered. https://example.com/webhooks/proxy The endpoint must be publicly accessible and respond within the configured read timeout. |

secret

string

Optional

Secret used to sign each webhook payload. The receiving endpoint should verify the signature to confirm the request originated from this platform. Auto-generated if left blank. Store this value securely on the receiving end.

readTimeout

int

Optional

Maximum time to wait for the endpoint to return a response. Requests that exceed this limit are treated as failed and may be retried.

writeTimeout

int

Optional

Maximum time to wait while sending the payload to the endpoint. Requests that exceed this limit are treated as failed and may be retried.

retries

int

Optional

Number of additional delivery attempts after an initial failure. Set to 0 to disable retries. 3 → up to 4 total delivery attempts

retryTimeout

int

Optional

How long to wait before each retry attempt after a failed delivery. 10 → retry after 10 seconds

created

DateTime

Required

| [readonly]

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::ConflictThe operation conflicts with the current resource or idempotency state.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->webhooks()->createWithResponse($webhookCreateRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['create'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->webhooks()->createWithHttpInfo($webhookCreateRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['create'][0])

  Returns the OpenAPI Generator response tuple.

• $client->webhooks()->createAsync($webhookCreateRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['create'][0])

  Returns a Guzzle promise for the decoded result.

• $client->webhooks()->createAsyncWithHttpInfo($webhookCreateRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['create'][0])

  Returns a Guzzle promise for the response tuple.

• $client->webhooks()->createRequest($webhookCreateRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['create'][0])

  Builds the PSR-7 request without sending it.

method

get()

Get a customer webhook

Returns one webhook destination owned by the authenticated account.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.webhooks.get(options: WebhooksGetOptions): Promise<WebhooksGetResponse>

Parameters

Name	Type	Requirement	Description
id	string	Required	A unique value identifying this Webhook.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.webhooks.get({
  id: "550e8400-e29b-41d4-a716-446655440000"
});

Returns

WebhookList

The operation completed successfully.

typeWebhookList8fields

FieldTypeRequirementDescription

id

string

Optional

—

type

WebhookScopeEnum

Optional

Context in which this webhook operates. Determines which events are delivered. User events scoped to the associated user account Reseller events scoped to the reseller and their sub-accounts System platform-wide system events * `user` - User * `reseller` - Reseller * `system` - System

enumWebhookScopeEnum0fields

* `user` - User * `reseller` - Reseller * `system` - System

No fields.

endpoint

string

Required

HTTPS URL that receives webhook POST requests when events are triggered. https://example.com/webhooks/proxy The endpoint must be publicly accessible and respond within the configured read timeout.

read_timeout

number

Optional

Maximum time to wait for the endpoint to return a response. Requests that exceed this limit are treated as failed and may be retried.

write_timeout

number

Optional

Maximum time to wait while sending the payload to the endpoint. Requests that exceed this limit are treated as failed and may be retried.

retries

number

Optional

Number of additional delivery attempts after an initial failure. Set to 0 to disable retries. 3 → up to 4 total delivery attempts

retry_timeout

number

Optional

How long to wait before each retry attempt after a failed delivery. 10 → retry after 10 seconds

created

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "not_found"The requested resource does not exist.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.webhooks.getWithResponse(options): Promise<ApiResponse<WebhooksGetResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.webhooks.get(id: str, *, accept_language: str | Unset=UNSET) -> WebhookList

Asyncawait async_client.webhooks.get(id: str, *, accept_language: str | Unset=UNSET) -> WebhookList

Parameters

Name	Type	Requirement	Description
id	str	Required	A unique value identifying this Webhook.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.webhooks.get(
        id='550e8400-e29b-41d4-a716-446655440000',
    )

Async example

result = await async_client.webhooks.get(
        id='550e8400-e29b-41d4-a716-446655440000',
    )

Returns

WebhookList

The operation completed successfully.

classWebhookList8fields

FieldTypeRequirementDescription

endpoint

str

Required

HTTPS URL that receives webhook POST requests when events are triggered. https://example.com/webhooks/proxy The endpoint must be publicly accessible and respond within the configured read timeout.

created

datetime.datetime

Required

—

id

str

Optional

—

type_

WebhookScopeEnum

Optional

* `user` - User * `reseller` - Reseller * `system` - System

enumWebhookScopeEnum0fields

No fields.

read_timeout

int

Optional

Maximum time to wait for the endpoint to return a response. Requests that exceed this limit are treated as failed and may be retried.

write_timeout

int

Optional

Maximum time to wait while sending the payload to the endpoint. Requests that exceed this limit are treated as failed and may be retried.

retries

int

Optional

Number of additional delivery attempts after an initial failure. Set to 0 to disable retries. 3 → up to 4 total delivery attempts

retry_timeout

int

Optional

How long to wait before each retry attempt after a failed delivery. 10 → retry after 10 seconds

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NOT_FOUNDThe requested resource does not exist.
• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.webhooks.get_with_response(id: str, *, accept_language: str | Unset=UNSET) -> ApiResponse[WebhookList]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->webhooks()->get($id, $acceptLanguage = null, string $contentType = self::contentTypes['get'][0])

Parameters

Name	Type	Requirement	Description
id	string	Required	A unique value identifying this Webhook.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->webhooks()->get(
    id: '550e8400-e29b-41d4-a716-446655440000',
);

Returns

WebhookList

The operation completed successfully.

classWebhookList8fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

type

WebhookScopeEnum

Optional

Context in which this webhook operates. Determines which events are delivered. User events scoped to the associated user account Reseller events scoped to the reseller and their sub-accounts System platform-wide system events * `user` - User * `reseller` - Reseller * `system` - System

enumWebhookScopeEnum0fields

* `user` - User * `reseller` - Reseller * `system` - System

No fields.

endpoint

string

Required

HTTPS URL that receives webhook POST requests when events are triggered. https://example.com/webhooks/proxy The endpoint must be publicly accessible and respond within the configured read timeout. |

readTimeout

int

Optional

Maximum time to wait for the endpoint to return a response. Requests that exceed this limit are treated as failed and may be retried.

writeTimeout

int

Optional

Maximum time to wait while sending the payload to the endpoint. Requests that exceed this limit are treated as failed and may be retried.

retries

int

Optional

Number of additional delivery attempts after an initial failure. Set to 0 to disable retries. 3 → up to 4 total delivery attempts

retryTimeout

int

Optional

How long to wait before each retry attempt after a failed delivery. 10 → retry after 10 seconds

created

DateTime

Required

| [readonly]

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NotFoundThe requested resource does not exist.
• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->webhooks()->getWithResponse($id, $acceptLanguage = null, string $contentType = self::contentTypes['get'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->webhooks()->getWithHttpInfo($id, $acceptLanguage = null, string $contentType = self::contentTypes['get'][0])

  Returns the OpenAPI Generator response tuple.

• $client->webhooks()->getAsync($id, $acceptLanguage = null, string $contentType = self::contentTypes['get'][0])

  Returns a Guzzle promise for the decoded result.

• $client->webhooks()->getAsyncWithHttpInfo($id, $acceptLanguage = null, string $contentType = self::contentTypes['get'][0])

  Returns a Guzzle promise for the response tuple.

• $client->webhooks()->getRequest($id, $acceptLanguage = null, string $contentType = self::contentTypes['get'][0])

  Builds the PSR-7 request without sending it.

method

delete()

Delete a customer webhook

Stops future event delivery to the selected destination and removes the webhook configuration.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.webhooks.delete(options: WebhooksDeleteOptions): Promise<WebhooksDeleteResponse>

Parameters

Name	Type	Requirement	Description
id	string	Required	A unique value identifying this Webhook.
idempotencyKey	string	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
ifMatch	string	Optional	Strong ETag from the latest representation of this resource.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.webhooks.delete({
  id: "550e8400-e29b-41d4-a716-446655440000"
});

Returns

void

No response body

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "not_found"The requested resource does not exist.
• kind: "conflict"The operation conflicts with the current resource or idempotency state.
• kind: "precondition"A required resource precondition is no longer satisfied.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.webhooks.deleteWithResponse(options): Promise<ApiResponse<WebhooksDeleteResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.webhooks.delete(id: str, *, idempotency_key: str | Unset=UNSET, if_match: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> None

Asyncawait async_client.webhooks.delete(id: str, *, idempotency_key: str | Unset=UNSET, if_match: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> None

Parameters

Name	Type	Requirement	Description
id	str	Required	A unique value identifying this Webhook.
idempotency_key	str	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
if_match	str	Optional	Strong ETag from the latest representation of this resource.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.webhooks.delete(
        id='550e8400-e29b-41d4-a716-446655440000',
    )

Async example

result = await async_client.webhooks.delete(
        id='550e8400-e29b-41d4-a716-446655440000',
    )

Returns

None

No response body

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NOT_FOUNDThe requested resource does not exist.
• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.CONFLICTThe operation conflicts with the current resource or idempotency state.
• ErrorKind.PRECONDITIONA required resource precondition is no longer satisfied.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.webhooks.delete_with_response(id: str, *, idempotency_key: str | Unset=UNSET, if_match: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[None]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->webhooks()->delete($id, $idempotencyKey = null, $ifMatch = null, $acceptLanguage = null, string $contentType = self::contentTypes['delete'][0])

Parameters

Name	Type	Requirement	Description
id	string	Required	A unique value identifying this Webhook.
idempotencyKey	string	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
ifMatch	string	Optional	Strong ETag from the latest representation of this resource.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->webhooks()->delete(
    id: '550e8400-e29b-41d4-a716-446655440000',
);

Returns

void

No response body

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NotFoundThe requested resource does not exist.
• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::ConflictThe operation conflicts with the current resource or idempotency state.
• ErrorKind::PreconditionA required resource precondition is no longer satisfied.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->webhooks()->deleteWithResponse($id, $idempotencyKey = null, $ifMatch = null, $acceptLanguage = null, string $contentType = self::contentTypes['delete'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->webhooks()->deleteWithHttpInfo($id, $idempotencyKey = null, $ifMatch = null, $acceptLanguage = null, string $contentType = self::contentTypes['delete'][0])

  Returns the OpenAPI Generator response tuple.

• $client->webhooks()->deleteAsync($id, $idempotencyKey = null, $ifMatch = null, $acceptLanguage = null, string $contentType = self::contentTypes['delete'][0])

  Returns a Guzzle promise for the decoded result.

• $client->webhooks()->deleteAsyncWithHttpInfo($id, $idempotencyKey = null, $ifMatch = null, $acceptLanguage = null, string $contentType = self::contentTypes['delete'][0])

  Returns a Guzzle promise for the response tuple.

• $client->webhooks()->deleteRequest($id, $idempotencyKey = null, $ifMatch = null, $acceptLanguage = null, string $contentType = self::contentTypes['delete'][0])

  Builds the PSR-7 request without sending it.