Get Bucket Webhooks

Retrieve the webhook notification rules of a bucket you own.
EndpointMethodAdmin Required
/api/v1/buckets/:bucketName/notificationsGETNo

Returns the webhook notification rules configured for a bucket you own. Alarik POSTs an S3-compatible event message to each enabled rule's URL when a matching object is created or removed. See Webhooks for the payload format and delivery semantics.

Path Parameters

bucketName
string required
The name of the bucket.

Response

{
    "rules": [
        {
            "id": "6ff08747-4ec0-48fd-a0b1-f5adda6d3161",
            "url": "https://example.com/webhook",
            "events": ["s3:ObjectCreated:*", "s3:ObjectRemoved:Delete"],
            "prefix": "uploads/",
            "suffix": ".jpg",
            "enabled": true
        }
    ]
}

The secret is never returned - it is write-only, like a password.

Errors

StatusReason
400Missing bucket name
404Bucket not found (or not owned by you)

Delete Bucket Tags

Remove all tags from a bucket you own.

Set Bucket Webhooks

Replace the webhook notification rules of a bucket you own.