Skip to main content

Documentation Index

Fetch the complete documentation index at: https://getconvoy.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Convoy’s API is RESTful, and as such, we use conventional HTTP status codes to indicate the status of every request.

​
HTTP codes

CodeDescription
201 CreatedResource was created successfully
400 Bad RequestThe request failed due to an unacceptable, most commonly an invalid parameter.
401 UnauthorizedA request to a protected endpoint did not have a valid API Key.
404 Not FoundResource does not exist.

​
Sample Error Response

{
  "status": false,
  "message": "invalid endpoint scheme"
}