Create merchant webhook endpoint

curl --request POST \
  --url https://api-test.drop-hub.com/v2/external/webhook-endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://merchant.example/webhooks/drophub",
  "subscribedEventTypes": [
    "shipment.created",
    "shipment.confirmed"
  ]
}
'

import requests

url = "https://api-test.drop-hub.com/v2/external/webhook-endpoints"

payload = {
    "url": "https://merchant.example/webhooks/drophub",
    "subscribedEventTypes": ["shipment.created", "shipment.confirmed"]
}
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: 'https://merchant.example/webhooks/drophub',
    subscribedEventTypes: ['shipment.created', 'shipment.confirmed']
  })
};

fetch('https://api-test.drop-hub.com/v2/external/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-test.drop-hub.com/v2/external/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' => 'https://merchant.example/webhooks/drophub',
    'subscribedEventTypes' => [
        'shipment.created',
        'shipment.confirmed'
    ]
  ]),
  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://api-test.drop-hub.com/v2/external/webhook-endpoints"

	payload := strings.NewReader("{\n  \"url\": \"https://merchant.example/webhooks/drophub\",\n  \"subscribedEventTypes\": [\n    \"shipment.created\",\n    \"shipment.confirmed\"\n  ]\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://api-test.drop-hub.com/v2/external/webhook-endpoints")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://merchant.example/webhooks/drophub\",\n  \"subscribedEventTypes\": [\n    \"shipment.created\",\n    \"shipment.confirmed\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-test.drop-hub.com/v2/external/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\": \"https://merchant.example/webhooks/drophub\",\n  \"subscribedEventTypes\": [\n    \"shipment.created\",\n    \"shipment.confirmed\"\n  ]\n}"

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

{
  "endpoint": {
    "endpointId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "<string>",
    "status": "ACTIVE",
    "subscribedEventTypes": [
      "shipment.created"
    ],
    "version": 1,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "previousSecretValidUntil": "2023-11-07T05:31:56Z"
  }
}

{
  "type": "https://api.drop-hub.com/problems/access-denied",
  "title": "Access denied",
  "status": 403,
  "detail": "Access to this resource is denied.",
  "instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
  "code": "ACCESS_DENIED",
  "timestamp": "2026-08-22T18:30:00Z",
  "correlationId": "018f2d8a-1f00-7000-8000-000000000207",
  "requestId": "018f2d8a-1f00-7000-8000-000000000208"
}

{
  "type": "https://api.drop-hub.com/problems/authentication-required",
  "title": "Authentication required",
  "status": 401,
  "detail": "Authentication is required for this resource.",
  "instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
  "code": "AUTHENTICATION_REQUIRED",
  "timestamp": "2026-08-22T18:30:00Z",
  "correlationId": "018f2d8a-1f00-7000-8000-000000000207",
  "requestId": "018f2d8a-1f00-7000-8000-000000000208"
}

{
  "type": "https://api.drop-hub.com/problems/access-denied",
  "title": "Access denied",
  "status": 403,
  "detail": "Access to this resource is denied.",
  "instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
  "code": "ACCESS_DENIED",
  "timestamp": "2026-08-22T18:30:00Z",
  "correlationId": "018f2d8a-1f00-7000-8000-000000000207",
  "requestId": "018f2d8a-1f00-7000-8000-000000000208"
}

{
  "type": "https://api.drop-hub.com/problems/access-denied",
  "title": "Access denied",
  "status": 403,
  "detail": "Access to this resource is denied.",
  "instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
  "code": "ACCESS_DENIED",
  "timestamp": "2026-08-22T18:30:00Z",
  "correlationId": "018f2d8a-1f00-7000-8000-000000000207",
  "requestId": "018f2d8a-1f00-7000-8000-000000000208"
}

{
  "type": "https://api.drop-hub.com/problems/access-denied",
  "title": "Access denied",
  "status": 403,
  "detail": "Access to this resource is denied.",
  "instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
  "code": "ACCESS_DENIED",
  "timestamp": "2026-08-22T18:30:00Z",
  "correlationId": "018f2d8a-1f00-7000-8000-000000000207",
  "requestId": "018f2d8a-1f00-7000-8000-000000000208"
}

{
  "type": "https://api.drop-hub.com/problems/access-denied",
  "title": "Access denied",
  "status": 403,
  "detail": "Access to this resource is denied.",
  "instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
  "code": "ACCESS_DENIED",
  "timestamp": "2026-08-22T18:30:00Z",
  "correlationId": "018f2d8a-1f00-7000-8000-000000000207",
  "requestId": "018f2d8a-1f00-7000-8000-000000000208"
}

{
  "type": "https://api.drop-hub.com/problems/access-denied",
  "title": "Access denied",
  "status": 403,
  "detail": "Access to this resource is denied.",
  "instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
  "code": "ACCESS_DENIED",
  "timestamp": "2026-08-22T18:30:00Z",
  "correlationId": "018f2d8a-1f00-7000-8000-000000000207",
  "requestId": "018f2d8a-1f00-7000-8000-000000000208"
}

POST

external

webhook-endpoints

Create merchant webhook endpoint

curl --request POST \
  --url https://api-test.drop-hub.com/v2/external/webhook-endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://merchant.example/webhooks/drophub",
  "subscribedEventTypes": [
    "shipment.created",
    "shipment.confirmed"
  ]
}
'

import requests

url = "https://api-test.drop-hub.com/v2/external/webhook-endpoints"

payload = {
    "url": "https://merchant.example/webhooks/drophub",
    "subscribedEventTypes": ["shipment.created", "shipment.confirmed"]
}
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: 'https://merchant.example/webhooks/drophub',
    subscribedEventTypes: ['shipment.created', 'shipment.confirmed']
  })
};

fetch('https://api-test.drop-hub.com/v2/external/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-test.drop-hub.com/v2/external/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' => 'https://merchant.example/webhooks/drophub',
    'subscribedEventTypes' => [
        'shipment.created',
        'shipment.confirmed'
    ]
  ]),
  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://api-test.drop-hub.com/v2/external/webhook-endpoints"

	payload := strings.NewReader("{\n  \"url\": \"https://merchant.example/webhooks/drophub\",\n  \"subscribedEventTypes\": [\n    \"shipment.created\",\n    \"shipment.confirmed\"\n  ]\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://api-test.drop-hub.com/v2/external/webhook-endpoints")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://merchant.example/webhooks/drophub\",\n  \"subscribedEventTypes\": [\n    \"shipment.created\",\n    \"shipment.confirmed\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-test.drop-hub.com/v2/external/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\": \"https://merchant.example/webhooks/drophub\",\n  \"subscribedEventTypes\": [\n    \"shipment.created\",\n    \"shipment.confirmed\"\n  ]\n}"

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

{
  "endpoint": {
    "endpointId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "<string>",
    "status": "ACTIVE",
    "subscribedEventTypes": [
      "shipment.created"
    ],
    "version": 1,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "previousSecretValidUntil": "2023-11-07T05:31:56Z"
  }
}

{
  "type": "https://api.drop-hub.com/problems/access-denied",
  "title": "Access denied",
  "status": 403,
  "detail": "Access to this resource is denied.",
  "instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
  "code": "ACCESS_DENIED",
  "timestamp": "2026-08-22T18:30:00Z",
  "correlationId": "018f2d8a-1f00-7000-8000-000000000207",
  "requestId": "018f2d8a-1f00-7000-8000-000000000208"
}

{
  "type": "https://api.drop-hub.com/problems/authentication-required",
  "title": "Authentication required",
  "status": 401,
  "detail": "Authentication is required for this resource.",
  "instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
  "code": "AUTHENTICATION_REQUIRED",
  "timestamp": "2026-08-22T18:30:00Z",
  "correlationId": "018f2d8a-1f00-7000-8000-000000000207",
  "requestId": "018f2d8a-1f00-7000-8000-000000000208"
}

{
  "type": "https://api.drop-hub.com/problems/access-denied",
  "title": "Access denied",
  "status": 403,
  "detail": "Access to this resource is denied.",
  "instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
  "code": "ACCESS_DENIED",
  "timestamp": "2026-08-22T18:30:00Z",
  "correlationId": "018f2d8a-1f00-7000-8000-000000000207",
  "requestId": "018f2d8a-1f00-7000-8000-000000000208"
}

{
  "type": "https://api.drop-hub.com/problems/access-denied",
  "title": "Access denied",
  "status": 403,
  "detail": "Access to this resource is denied.",
  "instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
  "code": "ACCESS_DENIED",
  "timestamp": "2026-08-22T18:30:00Z",
  "correlationId": "018f2d8a-1f00-7000-8000-000000000207",
  "requestId": "018f2d8a-1f00-7000-8000-000000000208"
}

{
  "type": "https://api.drop-hub.com/problems/access-denied",
  "title": "Access denied",
  "status": 403,
  "detail": "Access to this resource is denied.",
  "instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
  "code": "ACCESS_DENIED",
  "timestamp": "2026-08-22T18:30:00Z",
  "correlationId": "018f2d8a-1f00-7000-8000-000000000207",
  "requestId": "018f2d8a-1f00-7000-8000-000000000208"
}

{
  "type": "https://api.drop-hub.com/problems/access-denied",
  "title": "Access denied",
  "status": 403,
  "detail": "Access to this resource is denied.",
  "instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
  "code": "ACCESS_DENIED",
  "timestamp": "2026-08-22T18:30:00Z",
  "correlationId": "018f2d8a-1f00-7000-8000-000000000207",
  "requestId": "018f2d8a-1f00-7000-8000-000000000208"
}

{
  "type": "https://api.drop-hub.com/problems/access-denied",
  "title": "Access denied",
  "status": 403,
  "detail": "Access to this resource is denied.",
  "instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
  "code": "ACCESS_DENIED",
  "timestamp": "2026-08-22T18:30:00Z",
  "correlationId": "018f2d8a-1f00-7000-8000-000000000207",
  "requestId": "018f2d8a-1f00-7000-8000-000000000208"
}

Authorizations

Authorization

string

header

required

OAuth 2.0 client-credentials flow for external machine-to-machine integrations.

Headers

Accept-Language

string

Preferred response language when a localized representation is available.

Maximum string length: 64

Example:

"en"

Body

application/json

url

string<uri>

required

Maximum string length: 2048

subscribedEventTypes

enum<string>[]

required

Required array length: 1 - 11 elements

Available options:

shipment.created,

shipment.confirmed,

shipment.assigned,

driver.accepted,

driver.rejected,

driver.arrived_at_pickup,

shipment.picked_up,

driver.arrived_at_dropoff,

shipment.delivered,

shipment.delivery_failed,

shipment.cancelled

Response

Endpoint and one-time secret

endpoint

object

required

Show child attributes

⌘I

Getting Started

Authentication

Shipments

Events

Request semantics

API reference

Create merchant webhook endpoint

Authorizations

Headers

Body

Response