How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Convelio Webhook API

The Webhook API allows an API partner to create and manage webhooks.

Convelio Webhook API is one of 2 APIs that Convelio publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 2 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against 2 base URLs: https://api.sandbox.convelio.com/v2, https://api.convelio.com/v2.

5 operations 2 paths 12 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://api.convelio.com/v2
Authentication
API Key, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Convelio Webhook API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Convelio-signature (convelio_signature). An API key is passed in the header as Authorization (secret_token). By default, every request must be authenticated.

  • convelio_signature — An HMAC SHA256 signature created with the body data and the API secret token.
  • secret_token — token

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

webhook 5

The Webhook API allows an API partner to create and manage webhooks.

GET
/webhook
List registered webhooks
listWebhooks 2 params → 200401403500
POST
/webhook
Create webhook
createWebhook 2 params body → 201401403422500
GET
/webhook/{webhookId}
Get webhook
getWebhook 3 params → 200401403404500
PUT
/webhook/{webhookId}
Update webhook
updateWebhook 3 params body → 200401403404422500
DELETE
/webhook/{webhookId}
Delete webhook
deleteWebhook 3 params → 204401403404500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are http-error (4 properties), webhook (4 properties), document-ready-event (3 properties), shipment-status-changed-event (3 properties). Each schema is shown below with its type and property counts.

shipment-status-changed-event
object
3 properties
webhook-update
object
1 property 1 required
custom-quote-ready-event
object
3 properties
orde-created-event
object
3 properties
quote-paid-event
object
3 properties
http-error
object
The error model for the API follow the Content-Type application/problem+json defined by the [IETF RFC 7807](https://tools.ietf.org/html/rfc7807). Description o…
4 properties 4 required
http-unprocessable-entity-error
object
triggering-event-name
string
document-ready-event
object
3 properties
webhook
object
A webhook (also called a web callback or HTTP push API) is a way for an app to provide other applications with real-time information.
4 properties 2 required
webhook-url
string
URL to receive webhooks.
shipment-status
string
The shipment status of the tracked order. Possible values: - shipmentcreated: The Order has been booked and our team is planning collection at the pickup locat…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

convelio-webhook-api-openapi.yml Raw ↑

Other APIs Convelio publishes across the network.

Convelio Shipping API
Where this information came from

This is an independent, third-party profile of Convelio Webhook API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.