Actions118
- Item Actions
- Activity Actions
- Asset Actions
- Authentication Actions
- Collection Actions
- Extension Actions
- Field Actions
- File Actions
- Folder Actions
- Permission Actions
- Preset Actions
- Relation Actions
- Revision Actions
- Role Actions
- Server Actions
- Setting Actions
- User Actions
- Utility Actions
- Webhook Actions
Webhook → Update
AI-generatedOverview
This node updates an existing webhook in the Directus system. It is useful for modifying webhook configurations such as changing the webhook's name, URL, or other properties by providing the webhook's ID and the updated data in JSON format. For example, you can update a webhook to change its target URL or adjust its event triggers.
Use Case Examples
- Update a webhook's name and URL by specifying its ID and the new data in JSON format.
- Modify webhook settings dynamically based on application logic.
Properties
| Name | Meaning |
|---|---|
| ID | Primary key of the webhook to update, used to identify which webhook to modify. |
| Data (JSON) | A partial webhook object in JSON format containing the fields to update on the webhook. |
Output
JSON
id- The unique identifier of the updated webhook.name- The name of the updated webhook.url- The URL endpoint of the updated webhook.status- The status of the updated webhook (e.g., active or inactive).events- The events that trigger the webhook.
Dependencies
- Requires API authentication to the Directus system to perform webhook updates.
Troubleshooting
- Ensure the provided webhook ID exists; otherwise, the update will fail with a not found error.
- Validate the JSON data format to avoid syntax errors or invalid fields.
- Check API permissions to confirm the user has rights to update webhooks.
Links
- Directus Webhook Object Documentation - Reference for the webhook object structure and fields used in the update data.