Create Webhook Endpoint

curl --request POST \
  --url https://api.hopnow.io/v1/customers/{customer_id}/webhook-endpoints \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "<string>",
  "events": [
    {}
  ],
  "description": "<string>"
}
'

import requests

url = "https://api.hopnow.io/v1/customers/{customer_id}/webhook-endpoints"

payload = {
    "url": "<string>",
    "events": [{}],
    "description": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({url: '<string>', events: [{}], description: '<string>'})
};

fetch('https://api.hopnow.io/v1/customers/{customer_id}/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://api.hopnow.io/v1/customers/{customer_id}/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>',
    'events' => [
        [
                
        ]
    ],
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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://api.hopnow.io/v1/customers/{customer_id}/webhook-endpoints"

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

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

	req.Header.Add("X-API-Key", "<api-key>")
	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://api.hopnow.io/v1/customers/{customer_id}/webhook-endpoints")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"events\": [\n    {}\n  ],\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hopnow.io/v1/customers/{customer_id}/webhook-endpoints")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"events\": [\n    {}\n  ],\n  \"description\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "object": "<string>",
  "url": "<string>",
  "events": [
    {}
  ],
  "description": "<string>",
  "secret": "<string>",
  "warning": "<string>",
  "created": "<string>",
  "updated": "<string>",
  "created_by": "<string>",
  "updated_by": "<string>",
  "last_used_at": "<string>",
  "deleted_at": "<string>"
}

POST

customers

{customer_id}

webhook-endpoints

Create Webhook Endpoint

curl --request POST \
  --url https://api.hopnow.io/v1/customers/{customer_id}/webhook-endpoints \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "<string>",
  "events": [
    {}
  ],
  "description": "<string>"
}
'

import requests

url = "https://api.hopnow.io/v1/customers/{customer_id}/webhook-endpoints"

payload = {
    "url": "<string>",
    "events": [{}],
    "description": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({url: '<string>', events: [{}], description: '<string>'})
};

fetch('https://api.hopnow.io/v1/customers/{customer_id}/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://api.hopnow.io/v1/customers/{customer_id}/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>',
    'events' => [
        [
                
        ]
    ],
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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://api.hopnow.io/v1/customers/{customer_id}/webhook-endpoints"

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

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

	req.Header.Add("X-API-Key", "<api-key>")
	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://api.hopnow.io/v1/customers/{customer_id}/webhook-endpoints")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"events\": [\n    {}\n  ],\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hopnow.io/v1/customers/{customer_id}/webhook-endpoints")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"events\": [\n    {}\n  ],\n  \"description\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "object": "<string>",
  "url": "<string>",
  "events": [
    {}
  ],
  "description": "<string>",
  "secret": "<string>",
  "warning": "<string>",
  "created": "<string>",
  "updated": "<string>",
  "created_by": "<string>",
  "updated_by": "<string>",
  "last_used_at": "<string>",
  "deleted_at": "<string>"
}

The response includes a signing secret that is shown only once. Store it securely and treat it as an opaque value.

Path Parameters

string

required

The customer’s external ID (starts with cus_)

Request Body

string

required

The HTTPS URL where webhook events will be sent

array

required

Event types to subscribe to. At least one event is required.Supported HOP events are deposit.received, deposit.returned, withdraw.created, withdraw.completed, withdraw.failed, withdraw.cancelled, account.created, and account.updated.

string

Optional description for the webhook endpoint (maximum 255 characters)

See Webhook Events for the event envelope and payload details.

Response

string

Webhook endpoint identifier (starts with wh_)

string

Always returns "webhook_endpoint"

string

The webhook delivery URL

array

Subscribed event types

string

The webhook description, or null

string

Webhook signing secret. This field is returned only when the endpoint is created.

string

Security warning about storing the secret

string

ISO 8601 creation timestamp

string

ISO 8601 last-update timestamp

string

Identifier of the actor that created the endpoint, or null

string

Identifier of the actor that last updated the endpoint, or null

string

Timestamp of the most recent successful delivery, or null if no delivery has been recorded

string

Deletion timestamp. This is null for a newly created endpoint.

Response Example

{
  "id": "wh_1234567890abcdefghijklmn",
  "object": "webhook_endpoint",
  "url": "https://api.mycompany.com/webhooks/hopnow",
  "events": ["deposit.received", "withdraw.completed", "account.created"],
  "description": "Production webhook for account activity",
  "secret": "example_webhook_signing_secret",
  "warning": "Store this secret securely. It will not be shown again.",
  "created": "2026-07-15T02:00:00Z",
  "updated": "2026-07-15T02:00:00Z",
  "created_by": null,
  "updated_by": null,
  "last_used_at": null,
  "deleted_at": null
}

List FX Trades List Webhook Endpoints

Getting Started

Guides

Webhooks

API Reference

Endpoints

Create Webhook Endpoint

Path Parameters

Request Body

Response

Response Example

​Path Parameters

​Request Body

​Response

​Response Example

Path Parameters

Request Body

Response

Response Example