Vultr Webhook Service (1.0.0)

Download OpenAPI specification:

Deliveries

Create Webhook Delivery

Accepts a webhook delivery request. The service will persist the delivery to the database, then asynchronously call the customer's webhook URL via HTTPS POST with an HMAC-SHA256 signature.

The response is 201 with no body — the delivery is queued and will be attempted asynchronously. Use the GET /deliveries/{uuid} endpoint to check the delivery status.

Authorizations:
API Key
Request Body schema: application/json
required
url
required
string <uri>

The customer's webhook URL. Must be HTTPS.

event_type
required
string

The type of event that triggered the webhook.

required
object

The JSON payload to send to the customer's webhook endpoint.

secret
required
string

The HMAC secret used to sign the webhook payload. The signature is sent in the X-Vultr-Signature header as sha256=<hex digest>.

Responses

Request samples

Content type
application/json
{}

Get Delivery Status

Retrieve the status of a webhook delivery by its UUID.

Authorizations:
API Key
path Parameters
uuid
required
string <uuid>

The UUID of the webhook delivery.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "url": "string",
  • "event_type": "string",
  • "payload": { },
  • "status": "pending",
  • "retry_count": 0,
  • "last_error": "string",
  • "created_at": "string",
  • "updated_at": "string"
}

Health

Health Check

View the current status of the webhook service.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}