POST /customer/api/update_webhook

Update your registered webhook URL, event subscriptions, or IP whitelist. Changes take effect immediately for all future Shogun event deliveries.

Use this endpoint to change your webhook’s destination URL, toggle it on or off, or update the IP whitelist. All fields are optional — send only the fields you want to change. Changes take effect immediately; the next event Shogun dispatches will use the updated configuration.

Endpoint

POST https://baasapi.payrepmfb.com/api/v1/customer/api/update_webhook_configuration

Authentication: Authorization: Bearer <token> — obtain a token from Generate Token.

Request parameters

url · string

The new HTTPS endpoint URL to deliver events to. Must use https://. Shogun will reject plain http:// endpoints.

Example: https://yourapp.com/webhooks/shogun-v2

is_active · boolean

Set to false to pause webhook delivery without deleting the configuration. Set to true to resume delivery.

ip_whitelist · array of strings

Replace the current IP whitelist with a new list of allowed IP addresses. Pass an empty array ([]) to remove all restrictions.

Example requests

Update the destination URL:

curl -X POST https://baasapi.payrepmfb.com/api/v1/customer/api/update_webhook_configuration \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://yourapp.com/webhooks/shogun-v2"
  }'

Pause delivery:

curl -X POST https://baasapi.payrepmfb.com/api/v1/customer/api/update_webhook_configuration \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "is_active": false
  }'

Restrict delivery to a specific IP:

curl -X POST https://baasapi.payrepmfb.com/api/v1/customer/api/update_webhook_configuration \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "ip_whitelist": ["203.0.113.42"]
  }'

Response

200 OK

status · boolean

true on success.

response_code · string

"00" on success.

message · string

Human-readable result message.

data · object

The full updated webhook configuration.

Show data fields

url · string

The current endpoint URL after the update.

is_active · boolean

Whether webhook delivery is currently enabled.

ip_whitelist · array of strings

The current IP whitelist after the update.

{
  "status": true,
  "response_code": "00",
  "message": "Webhook updated successfully",
  "data": {
    "url": "https://yourapp.com/webhooks/shogun-v2",
    "is_active": true,
    "ip_whitelist": []
  }
}