Skip to main content
POST
/
webhook
/
register
Register webhook
curl --request POST \
  --url https://api.orafi.app/v1/webhook/register \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://example.com/webhook"
}
'
{
  "success": true,
  "message": "Webhook registered successfully",
  "data": {
    "id": "webhook_abc123",
    "url": "https://example.com/webhook",
    "secret": "<string>",
    "events": [
      "payment.success",
      "payment.failed"
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.orafi.app/llms.txt

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

Authorizations

​
x-api-key
string
header
required

API key for merchant authentication required for most endpoints

Body

application/json
​
url
string<uri>
required

Webhook URL to receive events

Example:

"https://example.com/webhook"

Response

Webhook registered successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Webhook registered successfully"

​
data
object