Skip to main content
POST
/
webhook
/
subscribe
Subscribe to webhook events
curl --request POST \
  --url https://api.orafi.app/v1/webhook/subscribe \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "event": "payment.success"
}
'
{
  "success": true,
  "message": "Successfully subscribed to event",
  "data": null
}

Authorizations

​
x-api-key
string
header
required

API key for merchant authentication required for most endpoints

Body

application/json
​
event
string
required

Event type to subscribe to

Example:

"payment.success"

Response

Successfully subscribed to event

​
success
boolean
Example:

true

​
message
string
Example:

"Successfully subscribed to event"

​
data
unknown