patch https://{app}.{filespin}.{io}/api/v1/user/settings/update?update_key=webhook
Update webhook by sending below payload. All keys are mandatory.
REQUEST PAYLOAD
{
"key": "webhook",
"value": {
"web_urls": "https://myapp.example.org/receiver, https://myapp-backup.example.org/receiver",
"callback_events": {
"file-saved": true,
"file-processed": true,
"file-data-updated": true,
"file-deleted": true,
"file-undeleted": true,
"addon-processed": false
}
}
}
REQUEST PARAMETERS
| Parameters | Type | Description |
|---|---|---|
key | string | Set to webhook |
value.web_urls | string | Can be an empty string. A maximum of three URLs will be accepted (sent as a single comma separated string). |
value.callback_events | JSON | Accepts the keys listed below |
Callback events description
| Event | Description |
|---|---|
| file-saved | When a file is stored in your storage after user uploads a file through File Picker or through Upload API |
| file-processed | When image and video conversions are processed for a file as part of upload workflow or via Image or Video Conversion API |
| file-data-updated | When custom data is attached to a file using FileSpin. update method of File Picker or using Update File Data API |
| file-deleted | When image conversions, video transcodes or the original file is deleted using Delete API |
| file-undeleted | When the original file is undeleted using Undelete API |
| addon-processed | An addon has completed processing |