AXIAM PHP SDK

WebhookResponse
in package
implements JsonSerializable

FinalYes

Webhook response — omits the shared secret.

Table of Contents

Interfaces

JsonSerializable

Properties

$createdAt  : string
$enabled  : bool
$events  : array<string|int, mixed>
$id  : string
$retryPolicy  : RetryPolicy
$tenantId  : string
$updatedAt  : string
$url  : string

Methods

__construct()  : mixed
Constructs a WebhookResponse.
fromArray()  : self
Rebuilds a WebhookResponse 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 WebhookResponse.

public __construct(string $createdAt, bool $enabled, array<int, string> $events, string $id, RetryPolicy $retryPolicy, string $tenantId, string $updatedAt, string $url) : mixed
Parameters
$createdAt : string

the server's created_at field

$enabled : bool

the server's enabled field

$events : array<int, string>

the server's events field

$id : string

the server's id field

$retryPolicy : RetryPolicy

the server's retry_policy field

$tenantId : string

the server's tenant_id field

$updatedAt : string

the server's updated_at field

$url : string

the server's url field

fromArray()

Rebuilds a WebhookResponse 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