WebhookInstruction

DTO for an instruction - that is a representation of a configured webhook to a specific remote - contains all configuration information.

What type of message should be sent (WebhookType), where should it be sent to and what additional headers etc. should be sent.

Table of Contents

Methods

__construct()  : mixed
getAdditionalHeaders()  : array<string|int, mixed>|null
getDescription()  : string
getHttpMethod()  : string
getIdentifier()  : string|null
getName()  : string
getRow()  : array<string|int, mixed>
getSecret()  : string
getTargetUrl()  : string
getUid()  : int
getWebhookType()  : WebhookType|null
verifySSL()  : bool

Methods

__construct()

public __construct(string $url, string $secret[, string $method = 'POST' ][, bool $verifySSL = true ][, array<string|int, mixed> $additionalHeaders = [] ][, string|null $name = null ][, string|null $description = null ][, WebhookType|null $webhookType = null ][, string|null $identifier = null ][, int|null $uid = null ][, array<string|int, mixed> $row = [] ]) : mixed
Parameters
$url : string
$secret : string
$method : string = 'POST'
$verifySSL : bool = true
$additionalHeaders : array<string|int, mixed> = []
$name : string|null = null
$description : string|null = null
$webhookType : WebhookType|null = null
$identifier : string|null = null
$uid : int|null = null
$row : array<string|int, mixed> = []

getAdditionalHeaders()

public getAdditionalHeaders() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getDescription()

public getDescription() : string
Return values
string

getHttpMethod()

public getHttpMethod() : string
Return values
string

getIdentifier()

public getIdentifier() : string|null
Return values
string|null

getName()

public getName() : string
Return values
string

getRow()

public getRow() : array<string|int, mixed>
Internal
Return values
array<string|int, mixed>

getSecret()

public getSecret() : string
Return values
string

getTargetUrl()

public getTargetUrl() : string
Return values
string

getUid()

public getUid() : int
Return values
int

verifySSL()

public verifySSL() : bool
Return values
bool 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results