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": "<string>",
  "secret": "<string>",
  "events": [
    "<string>"
  ]
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "url": "<string>",
    "secret": "<string>",
    "events": [
      "<string>"
    ]
  }
}

Authorizations

x-api-key
string
header
required

Body

application/json
url
string
secret
string
events
string[]

Response

201 - application/json

Webhook registered

success
boolean
message
string
data
object