Skip to main content
POST
/
profile
/
webhook-endpoints
Create a webhook endpoint
curl --request POST \
  --url https://developersandbox-api.flutterwave.com/profile/webhook-endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "secret": "<string>",
  "supported_event_types": [
    "<string>"
  ],
  "status": "enabled",
  "meta": {},
  "description": "<string>"
}
'
{
  "status": "success",
  "message": "<string>",
  "data": {
    "url": "<string>",
    "secret": "<string>",
    "id": "<string>",
    "supported_event_types": [
      "<string>"
    ],
    "status": "enabled",
    "meta": {},
    "description": "<string>",
    "created_datetime": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Trace-Id
string

A unique identifier to track this operation. It must be between 12 and 255 characters in length.

Required string length: 12 - 255
​
X-Idempotency-Key
string

A unique identifier to prevent duplicate requests. It must be between 12 and 255 characters in length.

Required string length: 12 - 255

Body

application/json
​
url
string
required

Endpoint where webhooks would be sent

​
secret
string
required

Secret used in generating verification hash for webhook payloads sent to endpoint

Required string length: 36 - 72
​
supported_event_types
string[]

Event types accepted by endpoint

​
status
enum<string>

Status of webhook endpoint showing if it's allowed to receive webhooks

Available options:
enabled,
disabled
​
meta
object
​
description
string

Description of the webhook endpoint

Response

OK

​
status
enum<string>
Available options:
success,
failed
​
message
string
​
data
object