Skip to main content
POST
/
webhook
Create webhook
curl --request POST \
  --url https://processor-prod.up.railway.app/webhook \
  --header 'Content-Type: application/json' \
  --header 'x-service-key: <api-key>' \
  --data '
{
  "url": "https://your-site.com/webhook"
}
'
{
  "success": true,
  "status": 200,
  "message": "Webhook created successfully",
  "timestamp": "2025-09-17T01:09:23.027Z",
  "data": {
    "enabled": true,
    "url": "https://google.com/webhook",
    "secret": "z9o4j778vsn5ivog9beacrvld"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.bread.africa/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-service-key
string
header
required

Body

application/json
​
url
string

The webhook URL to receive notifications. Leave empty to disable.

Example:

"https://your-site.com/webhook"

Response

200 - application/json

Webhook created successfully

​
success
boolean
Example:

true

​
status
integer
Example:

200

​
message
string
Example:

"Webhook created successfully"

​
timestamp
string<date-time>
Example:

"2025-09-17T01:09:23.027Z"

​
data
object