TYPO3\CMS\Webhooks\Model\WebhookInstruction Class Reference

Public Member Functions
	__construct (private readonly string $url, private readonly string $secret, private readonly string $method='POST', private readonly bool $verifySSL=true, private readonly array $additionalHeaders=[], private readonly ?string $name=null, private readonly ?string $description=null, private readonly ?WebhookType $webhookType=null, private readonly ?string $identifier=null, private readonly ?int $uid=null, private readonly array $row=[])
	getUid ()
	getName ()
	getDescription ()
	getWebhookType ()
	getIdentifier ()
	getTargetUrl ()
	getHttpMethod ()
	verifySSL ()
	getSecret ()
	getAdditionalHeaders ()
	getRow ()

Detailed Description

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.

Definition at line 27 of file WebhookInstruction.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Webhooks\Model\WebhookInstruction::__construct	(	private readonly string	$url,
		private readonly string	$secret,
		private readonly string	$method = 'POST',
		private readonly bool	$verifySSL = true,
		private readonly array	$additionalHeaders = [],
		private readonly ?string	$name = null,
		private readonly ?string	$description = null,
		private readonly ?WebhookType	$webhookType = null,
		private readonly ?string	$identifier = null,
		private readonly ?int	$uid = null,
		private readonly array	$row = []
	)

Definition at line 29 of file WebhookInstruction.php.

Member Function Documentation

getAdditionalHeaders()

TYPO3\CMS\Webhooks\Model\WebhookInstruction::getAdditionalHeaders

(

)

Definition at line 88 of file WebhookInstruction.php.

Referenced by TYPO3\CMS\Webhooks\MessageHandler\WebhookMessageHandler\buildHeaders().

getDescription()

TYPO3\CMS\Webhooks\Model\WebhookInstruction::getDescription

(

)

Definition at line 53 of file WebhookInstruction.php.

References TYPO3\CMS\Redirects\Message\description.

getHttpMethod()

TYPO3\CMS\Webhooks\Model\WebhookInstruction::getHttpMethod

(

)

Definition at line 73 of file WebhookInstruction.php.

Referenced by TYPO3\CMS\Webhooks\MessageHandler\WebhookMessageHandler\sendRequest().

getIdentifier()

TYPO3\CMS\Webhooks\Model\WebhookInstruction::getIdentifier

(

)

Definition at line 63 of file WebhookInstruction.php.

References TYPO3\CMS\Webhooks\Message\$identifier.

Referenced by TYPO3\CMS\Webhooks\MessageHandler\WebhookMessageHandler\buildHash().

getName()

TYPO3\CMS\Webhooks\Model\WebhookInstruction::getName

(

)

Definition at line 48 of file WebhookInstruction.php.

getRow()

TYPO3\CMS\Webhooks\Model\WebhookInstruction::getRow

(

)

Definition at line 96 of file WebhookInstruction.php.

getSecret()

TYPO3\CMS\Webhooks\Model\WebhookInstruction::getSecret

(

)

Definition at line 83 of file WebhookInstruction.php.

Referenced by TYPO3\CMS\Webhooks\MessageHandler\WebhookMessageHandler\buildHash().

getTargetUrl()

TYPO3\CMS\Webhooks\Model\WebhookInstruction::getTargetUrl

(

)

Definition at line 68 of file WebhookInstruction.php.

References TYPO3\CMS\Webhooks\Message\$url.

Referenced by TYPO3\CMS\Webhooks\MessageHandler\WebhookMessageHandler\sendRequest().

getUid()

TYPO3\CMS\Webhooks\Model\WebhookInstruction::getUid

(

)

Definition at line 43 of file WebhookInstruction.php.

getWebhookType()

TYPO3\CMS\Webhooks\Model\WebhookInstruction::getWebhookType

(

)

Definition at line 58 of file WebhookInstruction.php.

verifySSL()

TYPO3\CMS\Webhooks\Model\WebhookInstruction::verifySSL

(

)

Definition at line 78 of file WebhookInstruction.php.

Referenced by TYPO3\CMS\Webhooks\MessageHandler\WebhookMessageHandler\sendRequest().