Skip to content

Commit 810831c

Browse files
authored
Update webhookUrl helper documentation
Clarified the behavior of the webhookUrl helper regarding the signalMethod parameter.
1 parent 5397309 commit 810831c

File tree

1 file changed

+2
-8
lines changed

1 file changed

+2
-8
lines changed

docs/features/webhooks.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -85,16 +85,10 @@ curl -X POST "https://example.com/webhooks/signal/order-workflow/1/mark-as-shipp
8585
The `$this->webhookUrl()` helper generates webhook URLs for starting workflows or sending signals.
8686

8787
```
88-
$this->webhookUrl();
89-
$this->webhookUrl('signalMethod');
88+
public function webhookUrl(string $signalMethod = ''): string
9089
```
9190

92-
Parameters
93-
- string $signalMethod = '' (optional)
94-
95-
If empty, returns the URL for starting the workflow.
96-
97-
If provided, returns the URL for sending a signal to an active workflow instance.
91+
If `$signalMethod` is empty or omitted, `$this->webhookUrl()` returns the URL for starting the workflow. If `$signalMethod` is provided, `$this->webhookUrl()` returns the URL for sending a signal to an active workflow instance.
9892

9993
```
10094
use Workflow\Activity;

0 commit comments

Comments
 (0)