PUT /clients/webhook

Registers or updates the HTTPS URL Conomy will call when a payment lifecycle event changes state. Send secretKey if your integration wants Conomy to sign each outbound delivery with the X-Webhook-Signature header. Use flavor only when you need separate URLs for static and dynamic CVU flows.

PUT/clients/webhook

Create or update webhook configuration

Headers

Bearer access token returned by the authentication endpoint.

The API key used for authentication when making requests to the API Gateway.

API version selector for Conomy endpoints. Use 24-04-2025 for the current version.

Identifies the application making the request.

Request body required

HTTPS URL Conomy will call for outbound webhook deliveries.

Optional shared secret used to sign deliveries with X-Webhook-Signature.

defaultcvu.staticcvu.dynamic

Responses

webhookUrlstringuri

Default webhook URL.

flavorstring

defaultcvu.staticcvu.dynamic

sourceFlavorstring

defaultcvu.staticcvu.dynamic

flavorsobject

Per-flavor webhook URLs keyed by flavor.

metadataobject

Request

PUT /sandbox/clients/webhook HTTP/1.1
Host: api.conomyhq.com
Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {YOUR_API_KEY}
conomyhq-api-version: 24-04-2025
User-Agent: MyApp/1.0
Content-Type: application/json

{
  "webhookUrl": "https://yourapp.example/webhooks/conomy",
  "secretKey": "{{WEBHOOK_SECRET}}"
}

const response = await fetch('https://api.conomyhq.com/sandbox/clients/webhook', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer {ACCESS_TOKEN}',
    'x-api-key': '{YOUR_API_KEY}',
    'conomyhq-api-version': '24-04-2025',
    'User-Agent': 'MyApp/1.0',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "webhookUrl": "https://yourapp.example/webhooks/conomy",
    "secretKey": "{{WEBHOOK_SECRET}}"
  }),
});

const data = await response.json();

import requests

payload = {
    "webhookUrl": "https://yourapp.example/webhooks/conomy",
    "secretKey": "{{WEBHOOK_SECRET}}"
}

response = requests.put(
    'https://api.conomyhq.com/sandbox/clients/webhook',
    headers={
    'Authorization': 'Bearer {ACCESS_TOKEN}',
    'x-api-key': '{YOUR_API_KEY}',
    'conomyhq-api-version': '24-04-2025',
    'User-Agent': 'MyApp/1.0',
    'Content-Type': 'application/json',
    },
    json=payload
)

data = response.json()

package main

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

func main() {
	payload, _ := json.Marshal(	{
	  "webhookUrl": "https://yourapp.example/webhooks/conomy",
	  "secretKey": "{{WEBHOOK_SECRET}}"
	})
	body := bytes.NewBuffer(payload)
	req, _ := http.NewRequest("PUT", "https://api.conomyhq.com/sandbox/clients/webhook", body)
	req.Header.Set("Authorization", "Bearer {ACCESS_TOKEN}")
	req.Header.Set("x-api-key", "{YOUR_API_KEY}")
	req.Header.Set("conomyhq-api-version", "24-04-2025")
	req.Header.Set("User-Agent", "MyApp/1.0")
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()

	var data map[string]any
	json.NewDecoder(resp.Body).Decode(&data)
}

use reqwest::Client;
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let resp = client
        .put("https://api.conomyhq.com/sandbox/clients/webhook")
        .header("Authorization", "Bearer {ACCESS_TOKEN}")
        .header("x-api-key", "{YOUR_API_KEY}")
        .header("conomyhq-api-version", "24-04-2025")
        .header("User-Agent", "MyApp/1.0")
        .header("Content-Type", "application/json")
        .json(&json!({
        "webhookUrl": "https://yourapp.example/webhooks/conomy",
        "secretKey": "{{WEBHOOK_SECRET}}"
}))
        .send()
        .await?;

    let data: serde_json::Value = resp.json().await?;
    Ok(())
}

Response

{
  "webhookUrl": "https://example.com/webhook",
  "flavor": "default",
  "sourceFlavor": "default",
  "flavors": {},
  "metadata": {}
}