Bamboo Card
GET

Get Notification

Retrieve the notification URLs and secret key currently configured for your Bamboo account.

GET/api/Integration/v1/notification

This endpoint retrieves the configured Notification URL callback. For the Svix-based webhook setup, see Webhooks.

Webhooks guide

Get Notification returns the notification callback URLs and secret key currently stored for your Bamboo account.

Use this endpoint to confirm your webhook configuration after you update it with the POST Notification endpoint.

This endpoint requires Basic Auth using your API credentials.

Response specifications

The response mirrors the notification configuration Bamboo will use for future callbacks.

FieldTypeDescription
notificationUrlstringConfigured production callback URL.
notificationUrlSandboxstringConfigured sandbox callback URL.
secretKeystringConfigured merchant verification secret.

Examples

Full request and response examples for this endpoint.

Example request

Use this full request as the primary reference for client-side implementation.

cURL - cURL
# Generate token: echo -n 'YOUR_CLIENT_ID:YOUR_CLIENT_SECRET' | base64

curl --location 'https://api.bamboocardportal.com/api/Integration/v1/notification' \
  --header 'Authorization: Basic YOUR_BASE64_TOKEN' \
  --header 'Accept: application/json'

Example response

Use this sample payload to validate parsing, field mapping, and downstream handling.

200 OK
JSON
{
  "notificationUrl": "https://yoururl/order/notification",
  "notificationUrlSandbox": "https://yoururl/order/notification",
  "secretKey": "76d247c4-015d-470e-9ff6-5c1c873d1e0d"
}

How to use this response

Use the response values to validate the current Bamboo callback configuration.

Configuration confirmation

Call Get Notification after updating your webhook settings to confirm Bamboo stored the expected URLs and secret key.

Sandbox vs production

Compare notificationUrl and notificationUrlSandbox to ensure test traffic and live traffic go to the intended destinations.

Operational notes

Get Notification is read-only and should be paired with the POST Notification endpoint when you need to change settings.

Read-only endpoint

This endpoint only retrieves the current notification configuration.

Update path

Use POST /api/Integration/v1/notification to update the stored notification values.

Callback validation

Keep the returned secretKey synchronized with your merchant-side webhook validation logic.

Environment awareness

Production and sandbox callback URLs may differ depending on how you process order events.

On this page

Try it out

Open the interactive API panel to test this endpoint with your own credentials.