Skip to content

Commit 149bf8a

Browse files
jorwoodsclaude
andcommitted
docs: add missing Webhooks methods to api-ref.md
Adds documentation for methods not previously documented: - webhook.delete: the delete method was referenced but had no dedicated section - webhook.test: tests a webhook by sending an empty payload to the destination URL Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 9162447 commit 149bf8a

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

docs/api-ref.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5905,6 +5905,65 @@ print (webhook.name, webhook.url)
59055905
<br>
59065906
<br>
59075907

5908+
#### webhook.delete
5909+
5910+
```py
5911+
webhooks.delete(webhook_id)
5912+
```
5913+
5914+
Deletes the specified webhook.
5915+
5916+
REST API: [Delete Webhook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_notifications.htm#delete_webhook){:target="_blank"}
5917+
5918+
**Parameters**
5919+
5920+
Name | Description
5921+
:--- | :---
5922+
`webhook_id` | The identifier (`id`) for the `WebhookItem` to delete.
5923+
5924+
**Version**
5925+
5926+
Version 3.6 and later. See [REST API versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm).
5927+
5928+
**Example**
5929+
5930+
```py
5931+
server.webhooks.delete('7d60d364-b9f5-4a9c-8aa5-4bdaa38c5dd3')
5932+
```
5933+
5934+
<br>
5935+
<br>
5936+
5937+
#### webhook.test
5938+
5939+
```py
5940+
webhooks.test(webhook_id)
5941+
```
5942+
5943+
Tests the specified webhook. Sends an empty payload to the webhook destination URL and returns the response from the server.
5944+
5945+
REST API: [Test a Webhook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_notifications.htm#test_webhook){:target="_blank"}
5946+
5947+
**Parameters**
5948+
5949+
Name | Description
5950+
:--- | :---
5951+
`webhook_id` | The identifier (`id`) for the `WebhookItem` to test.
5952+
5953+
**Version**
5954+
5955+
Version 3.6 and later. See [REST API versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm).
5956+
5957+
**Example**
5958+
5959+
```py
5960+
webhook = server.webhooks.get_by_id('7d60d364-b9f5-4a9c-8aa5-4bdaa38c5dd3')
5961+
server.webhooks.test(webhook.id)
5962+
```
5963+
5964+
<br>
5965+
<br>
5966+
59085967
### Additional Resources
59095968
- [REST API Endpoints](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_notifications.htm)
59105969
- [Webhooks Documentation](https://help.tableau.com/current/developer/webhooks/en-us/)

0 commit comments

Comments
 (0)