Meilisearch PHP | Documentation

Webhook
in package

FinalYes
Tags
phpstan-type

RawWebhook array{ uuid: non-empty-string, isEditable: bool, url: non-empty-string, headers: array<string, string> }

since

Meilisearch v1.17.0

Table of Contents

Properties

$headers  : array<string|int, mixed>
$isEditable  : bool
$url  : string
$uuid  : string

Methods

__construct()  : mixed
fromArray()  : self
getHeaders()  : array<string, string>
Header values can contain secrets: treat them as sensitive and do not log them.
getUrl()  : non-empty-string
getUuid()  : non-empty-string
isEditable()  : bool
toArray()  : array{uuid: non-empty-string, url: non-empty-string, headers: array, isEditable: bool}

Properties

$headers read-only

private array<string|int, mixed> $headers

$isEditable read-only

private bool $isEditable

$uuid read-only

private string $uuid

Methods

__construct()

public __construct(non-empty-string $uuid, non-empty-string $url, array<string, string> $headers, bool $isEditable) : mixed
Parameters
$uuid : non-empty-string
$url : non-empty-string
$headers : array<string, string>
$isEditable : bool

fromArray()

public static fromArray(RawWebhook $data) : self
Parameters
$data : RawWebhook
Return values
self

getHeaders()

Header values can contain secrets: treat them as sensitive and do not log them.

public getHeaders() : array<string, string>

Since Meilisearch v1.25.0 the authorization header value is partially redacted in responses; older versions and all other headers return the stored values unchanged.

Return values
array<string, string>

getUrl()

public getUrl() : non-empty-string
Return values
non-empty-string

getUuid()

public getUuid() : non-empty-string
Return values
non-empty-string

isEditable()

public isEditable() : bool
Return values
bool

toArray()

public toArray() : array{uuid: non-empty-string, url: non-empty-string, headers: array, isEditable: bool}
Return values
array{uuid: non-empty-string, url: non-empty-string, headers: array, isEditable: bool}
On this page

Search results