CreateWebhookRequest
in package
implements
JsonSerializable
The `CreateWebhookRequest` schema from the server's OpenAPI document.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $events : array<string|int, mixed>
- $retryPolicy : RetryPolicy|null
- $secret : Sensitive
- $url : string
Methods
- __construct() : mixed
- Constructs a CreateWebhookRequest.
- fromArray() : self
- Rebuilds a CreateWebhookRequest 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
$events read-only
public
array<string|int, mixed>
$events
$retryPolicy read-only
public
RetryPolicy|null
$retryPolicy
= null
$secret read-only
public
Sensitive
$secret
$url read-only
public
string
$url
Methods
__construct()
Constructs a CreateWebhookRequest.
public
__construct(array<int, string> $events, Sensitive $secret, string $url[, RetryPolicy|null $retryPolicy = null ]) : mixed
Parameters
- $events : array<int, string>
-
Event types to subscribe to (e.g.
["user.created", "auth.login"]). - $secret : Sensitive
-
HMAC-SHA256 shared secret for signing payloads.
- $url : string
-
The HTTPS URL to deliver events to.
- $retryPolicy : RetryPolicy|null = null
-
the server's
retry_policyfield (optional)
fromArray()
Rebuilds a CreateWebhookRequest from one decoded JSON object.
public
static fromArray(array<string, mixed> $data) : self
Parameters
- $data : array<string, mixed>
-
The raw wire object.
Return values
selfjsonSerialize()
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.