b2_get_bucket_notification_rules

11 Sep 2026

Print
Dark
Light

b2_get_bucket_notification_rules

Updated on 11 Sep 2026

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/b2api/v4/b2_get_bucket_notification_rules

Lists bucket event notification rules alphabetically by rule name

This will return an error if called on a non-existent bucketId.

Header parameters

Authorization

stringRequired

An account authorization token, obtained from b2_authorize_account.

The token must have the readBucketNotifications capability.

Query parameters

bucketId

stringRequired

The unique identifier for the bucket containing the event notification rules.

Responses

200

The request succeeded.

Bucket Notification Rules Response

[
  {
    "bucketId": "aea8c5bc362ae55070130333",
    "eventNotificationRules": [
      {
        "eventTypes": [
          "b2:ObjectCreated:Upload",
          "b2:ObjectCreated:MultipartUpload"
        ],
        "isEnabled": true,
        "isSuspended": false,
        "name": "mySampleRule1",
        "objectNamePrefix": "",
        "suspensionReason": "",
        "targetConfiguration": {
          "customHeaders": [
            {
              "name": "X-My-Custom-Header-1",
              "value": "myCustomHeaderVal1"
            },
            {
              "name": "X-My-Custom-Header-2",
              "value": "myCustomHeaderVal2"
            }
          ],
          "hmacSha256SigningSecret": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0",
          "targetType": "webhook",
          "url": "https://www.example.com/sampleurl"
        }
      }
    ]
  }
]

Expand All

object

bucketId

string

The unique identifier for the bucket containing the event notification rules.

Exampleaea8c5bc362ae55070130333

eventNotificationRules

Array of object

An array of Event Notification Rules.

Example[ { "eventTypes": [ "b2:ObjectCreated:Upload", "b2:ObjectCreated:MultipartUpload" ], "isEnabled": true, "isSuspended": false, "maxEventsPerBatch": 1, "name": "mySampleRule1", "objectNamePrefix": "", "suspensionReason": "", "targetConfiguration": { "customHeaders": [ { "name": "myCustomHeader1", "value": "myCustomHeaderVal1" }, { "name": "myCustomHeader2", "value": "myCustomHeaderVal2" } ], "hmacSha256SigningSecret": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0", "targetType": "webhook", "url": "https://www.example.com/sampleurl" } } ]

object

eventTypes

Array of string

The list of event types for the event notification rule.

Example[ "b2:ObjectCreated:*" ]

string

isEnabled

boolean

Whether the event notification rule is enabled.

Exampletrue

isSuspended

boolean

Whether the event notification rule is suspended.

Exampletrue

maxEventsPerBatch

integer

Represents the maximum number of events a user will receive per webhook invocation. The value must be a number between 1 and 50. The default value is 1.

Example1

name

string

A name for the event notification rule. The name must be unique among the bucket's notification rules.

ExamplemySampleRule1

objectNamePrefix

string

Specifies which object(s) in the bucket the event notification rule applies to.

Exampleimages/

suspensionReason

string

A brief description of why the event notification rule was suspended.

ExampleA reason for suspension

targetConfiguration

object

The target configuration for the event notification rule.

This object will always contain the targetType field. Currently, the only valid value for targetType is "webhook."

The fields for "webhook" objects are defined below. However, other targetType values and collections of fields will be available in the future.

Example{ "customHeaders": [ { "name": "myCustomHeader1", "value": "myCustomHeaderVal1" }, { "name": "myCustomHeader2", "value": "myCustomHeaderVal2" } ], "hmacSha256SigningSecret": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0", "targetType": "webhook", "url": "https://www.example.com/sampleurl" }

customHeaders

Array of object

When present, additional header name/value pairs to be sent on the webhook invocation.

Example[ { "name": "myCustomHeader1", "value": "myCustomHeaderVal1" } ]

object

name

string

The name of the header.

Examplemy-custom-header-name

value

string

The value of the header

Examplemy-custom-header-value

hmacSha256SigningSecret

string

The signing secret for use in verifying the X-Bz-Event-Notification-Signature.

ExampleMTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0

targetType

string

The type of the target configuration, currently "webhook" only.

Examplewebhook

url

string

The URL for the webhook.

Examplehttps://www.example.com

400

status	code	description
400	bad_bucket_id	bucketId is not valid.

object

status

integer

The numeric HTTP status code. Always matches the status in the HTTP response.

Example400

code

string

A single-identifier code that identifies the error.

Exampleinvalid_bucket_name

message

string

A human-readable message, in English, saying what went wrong.

Examplebucket name is too long

401

status	code	description
401	bad_auth_token	The auth token used is not valid. Call b2_authorize_account again to either get a new one, or an error message describing the problem.
401	expired_auth_token	The auth token used has expired. Call b2_authorize_account again to get a new one.
401	unauthorized	The auth token used is valid, but does not authorize this call with these parameters. The capabilities of an auth token are determined by the application key used with b2_authorize_account.

403

status	code	description
403	transaction_cap_exceeded	Transaction cap exceeded. Daily transaction caps apply to non-paying accounts. To view or adjust your caps, sign in to your B2 Cloud Storage account online and select the Caps & Alerts link in the B2 Cloud Storage section of the sidebar.

Was this article helpful?

What's Next

b2_get_download_authorization