AXIAM PHP SDK

UpdateWebhookRequest
in package
implements JsonSerializable

FinalYes

The `UpdateWebhookRequest` schema from the server's OpenAPI document.

Every property is optional, so this is a SPARSE body: what you leave unset is left unchanged, and is omitted from the wire request entirely rather than sent as null (§27.4 rule 5).

Table of Contents

Interfaces

JsonSerializable

Properties

$enabled  : bool|null
$events  : array<string|int, mixed>|null
$retryPolicy  : RetryPolicy|null
$secret  : Sensitive|null
$url  : string|null

Methods

__construct()  : mixed
Constructs a UpdateWebhookRequest.
fromArray()  : self
Rebuilds a UpdateWebhookRequest from one decoded JSON object.
jsonSerialize()  : array<string, mixed>
Renders this object for `json_encode()`.
toArray()  : array<string, mixed>
Renders this object back to its wire form.

Properties

Methods

__construct()

Constructs a UpdateWebhookRequest.

public __construct([bool|null $enabled = null ][, array<int, string>|null $events = null ][, RetryPolicy|null $retryPolicy = null ][, Sensitive|null $secret = null ][, string|null $url = null ]) : mixed
Parameters
$enabled : bool|null = null

the server's enabled field (optional)

$events : array<int, string>|null = null

the server's events field (optional)

$retryPolicy : RetryPolicy|null = null

the server's retry_policy field (optional)

$secret : Sensitive|null = null

New HMAC-SHA256 shared secret (D-02 secret rotation). Encrypted server-side with AES-256-GCM before storage; omit to leave the existing secret untouched. (optional)

$url : string|null = null

the server's url field (optional)

fromArray()

Rebuilds a UpdateWebhookRequest from one decoded JSON object.

public static fromArray(array<string, mixed> $data) : self
Parameters
$data : array<string, mixed>

The raw wire object.

Return values
self

jsonSerialize()

Renders this object for `json_encode()`.

public jsonSerialize() : array<string, mixed>

Any Sensitive it carries stays WRAPPED here, so a log line or a json_encode($model) in application code prints [SENSITIVE]. The one place a secret is revealed is ManagementTransport, on the way to the wire and nowhere else (§27.5).

Return values
array<string, mixed>

toArray()

Renders this object back to its wire form.

public toArray() : array<string, mixed>

§27.4 rule 5: a null property is OMITTED, not emitted as null. On a sparse update those two say opposite things — "leave this alone" versus "set this to nothing" — and only omission means the first.

Return values
array<string, mixed>
On this page

Search results