Skip to main content
POST
/
3p
/
api
/
v1
/
webhook
Register Webhook ( STABLE )
curl --request POST \
  --url https://api.grailpay.com/3p/api/v1/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "event_names": [
    "TransactionCompleted",
    "TransactionFailed"
  ],
  "webhook_url": "https://example.com/webhook/transaction"
}'
{
  "status": true,
  "message": "Webhook registered successfully!",
  "data": null,
  "errors": null,
  "error_code": null
}

Authorizations

​
Authorization
string
header
required

Sanctum token-based authentication using the Bearer scheme. This is provided by the GrailPay Customer Support Team

Body

application/json
​
event_names
string[]
required
Example:
["TransactionCompleted", "TransactionFailed"]
​
webhook_url
string
required
Example:

"https://example.com/webhook/transaction"

Response

Webhook registered successfully

​
status
boolean
Example:

true

​
message
string
Example:

"Webhook registered successfully!"

​
data
string
Example:

null

​
errors
string
Example:

null

​
error_code
string
Example:

null