Update Webhook

Update a webhook's URL or subscribed events.

Updates an existing webhook's URL and/or the events it's subscribed to.

Endpoint

PATCH /v1/webhooks/:id

Authentication

Header

Value

x-api-key

Your API key

Path parameters

Parameter

Type

Description

id

string

Webhook UUID

Request body

Field

Type

Required

Description

url

string

Updated webhook URL

events

string[]

Updated list of events (replaces existing list)

Example request

curl -X PATCH https://ramp-api.ivorypay.io/api/v1/webhooks/wh-uuid-1 \
  -H "x-api-key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://yourapp.com/webhooks/v2/ivorypay",
    "events": [
      "onramp.success",
      "onramp.failed",
      "offramp.success",
      "offramp.failed",
      "deposit.received",
      "settlement.success",
      "settlement.failed"
    ]
  }'

const response = await fetch("https://ramp-api.ivorypay.io/api/v1/webhooks/wh-uuid-1", {
  method: "PATCH",
  headers: {
    "x-api-key": "your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    url: "https://yourapp.com/webhooks/v2/ivorypay",
    events: [
      "onramp.success",
      "onramp.failed",
      "offramp.success",
      "offramp.failed",
      "deposit.received",
      "settlement.success",
      "settlement.failed",
    ],
  }),
});

const data = await response.json();
console.log(data);

import requests

response = requests.patch(
    "https://ramp-api.ivorypay.io/api/v1/webhooks/wh-uuid-1",
    headers={
        "x-api-key": "your_api_key",
        "Content-Type": "application/json",
    },
    json={
        "url": "https://yourapp.com/webhooks/v2/ivorypay",
        "events": [
            "onramp.success",
            "onramp.failed",
            "offramp.success",
            "offramp.failed",
            "deposit.received",
            "settlement.success",
            "settlement.failed",
        ],
    },
)

print(response.json())

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io"
	"net/http"
)

func main() {
	payload := map[string]interface{}{
		"url": "https://yourapp.com/webhooks/v2/ivorypay",
		"events": []string{
			"onramp.success",
			"onramp.failed",
			"offramp.success",
			"offramp.failed",
			"deposit.received",
			"settlement.success",
			"settlement.failed",
		},
	}

	body, _ := json.Marshal(payload)

	req, _ := http.NewRequest("PATCH", "https://ramp-api.ivorypay.io/api/v1/webhooks/wh-uuid-1", bytes.NewBuffer(body))
	req.Header.Set("x-api-key", "your_api_key")
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	respBody, _ := io.ReadAll(resp.Body)
	fmt.Println(string(respBody))
}

Example response

{
  "statusCode": 200,
  "success": true,
  "message": "Webhook updated successfully",
  "data": {
    "id": "wh-uuid-1",
    "url": "https://yourapp.com/webhooks/v2/ivorypay",
    "environment": "LIVE",
    "events": [
      "onramp.success",
      "onramp.failed",
      "offramp.success",
      "offramp.failed",
      "deposit.received",
      "settlement.success",
      "settlement.failed"
    ]
  }
}

PreviousList Webhooks NextDelete Webhook

Last updated 1 month ago

hashtagEndpoint

hashtagAuthentication

hashtagPath parameters

hashtagRequest body

hashtagExample request