Create a webhook endpoint

Create a webhook endpoint

POST /profile/webhook-endpoints

Create a webhook endpoint

cURL

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>"
  ],
  "meta": {},
  "description": "<string>"
}
'

import requests

url = "https://developersandbox-api.flutterwave.com/profile/webhook-endpoints"

payload = {
    "url": "<string>",
    "secret": "<string>",
    "supported_event_types": ["<string>"],
    "meta": {},
    "description": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: '<string>',
    secret: '<string>',
    supported_event_types: ['<string>'],
    meta: {},
    description: '<string>'
  })
};

fetch('https://developersandbox-api.flutterwave.com/profile/webhook-endpoints', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://developersandbox-api.flutterwave.com/profile/webhook-endpoints",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => '<string>',
    'secret' => '<string>',
    'supported_event_types' => [
        '<string>'
    ],
    'meta' => [
        
    ],
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://developersandbox-api.flutterwave.com/profile/webhook-endpoints"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"secret\": \"<string>\",\n  \"supported_event_types\": [\n    \"<string>\"\n  ],\n  \"meta\": {},\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://developersandbox-api.flutterwave.com/profile/webhook-endpoints")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"secret\": \"<string>\",\n  \"supported_event_types\": [\n    \"<string>\"\n  ],\n  \"meta\": {},\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://developersandbox-api.flutterwave.com/profile/webhook-endpoints")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"secret\": \"<string>\",\n  \"supported_event_types\": [\n    \"<string>\"\n  ],\n  \"meta\": {},\n  \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "message": "<string>",
  "data": {
    "url": "<string>",
    "secret": "<string>",
    "id": "<string>",
    "supported_event_types": [
      "<string>"
    ],
    "meta": {},
    "description": "<string>",
    "created_datetime": "2023-11-07T05:31:56Z"
  }
}

{
  "status": "failed",
  "error": {
    "type": "REQUEST_NOT_VALID",
    "code": "10400",
    "message": "Request is not valid",
    "validation_errors": [
      {
        "field_name": "amount",
        "message": "must not be null"
      }
    ]
  }
}

{
  "status": "failed",
  "message": "UNAUTHORIZED",
  "error": {
    "type": "UNAUTHORIZED",
    "code": "10401",
    "message": "unauthorized"
  }
}

{
  "status": "failed",
  "message": "<string>",
  "error": {
    "type": "FORBIDDEN",
    "code": "10403",
    "message": "Forbidden"
  }
}

{
  "status": "failed",
  "message": "<string>",
  "error": {
    "type": "RESOURCE_CONFLICT",
    "code": "10409",
    "message": "Resource conflict"
  }
}

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

Show child attributes

description · string

Description of the webhook endpoint

Response

200

application/json

OK

status · enum<string>

Available options: success, failed

message · string

data · object

Show child attributes