Skip to main content
POST
/
v1
/
webhooks
Create a webhook
curl --request POST \
  --url https://business.papp.sa/api/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Order Notification",
  "url": "https://merchant.example.com/webhooks/orders"
}
'
{
  "status": true,
  "message": "",
  "appended_data": {},
  "data": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "merchant_id": 123,
    "name": "Order Notification",
    "url": "https://merchant.example.com/webhooks/orders",
    "secret": "abc123def456",
    "created_at": "2024-12-23T10:00:00.000Z",
    "updated_at": "2024-12-23T15:30:00.000Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.papp.sa/llms.txt

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

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
name
string
required
Maximum string length: 255
Example:

"Order Notification"

​
url
string<uri>
required
Maximum string length: 500
Example:

"https://merchant.example.com/webhooks/orders"

Response

Webhook created successfully.

​
status
boolean
required
Example:

true

​
message
string | null
required
Example:

""

​
appended_data
object
required
Example:
{}
​
data
object
required