Skip to main content

Managing Webhooks

You can register, retrieve, and delete webhooks using the API.

Registering a Webhook​

Endpoint Details​

  • Method: POST
  • URL: /api/v2/customer/{CUSTOMER_ID}/webhooks
  • Content-Type: application/json
  • Response: 201 Created (No response body)

Request Body​

FieldTypeDescriptionRequired
urlstringThe URL to receive webhook notifications.✅ Yes
eventstringThe event to subscribe to.✅ Yes

Example Request​

{
  "url": "https://yourdomain.com/webhook-endpoint",
  "event": "rfq.status_changed"
}

Retrieving Webhooks​

Endpoint Details​

  • Method: GET
  • URL: /api/v2/customer/{CUSTOMER_ID}/webhooks

Response Structure​

[
  {
    "event": "quote.status_changed",
    "webhooks": [
      {
        "customerId": "001U7000003PpXVIA0",
        "url": "https://localhost:9999/api/v2/customer/testwebhook",
        "id": 1
      }
    ]
  }
]

Deleting a Webhook​

Endpoint Details​

  • Method: DELETE
  • URL: /api/v2/customer/{CUSTOMER_ID}/webhooks/{WEBHOOK_ID}

Response​

{
  "message": "Webhook deleted successfully."
}