POST
/
v1
/
projects
/
{projectID}
/
endpoints
curl --request POST \
  --url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/endpoints \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "advanced_signatures": true,
  "appID": "<string>",
  "authentication": {
    "api_key": {
      "header_name": "<string>",
      "header_value": "<string>"
    },
    "type": "api_key"
  },
  "description": "<string>",
  "http_timeout": 123,
  "is_disabled": true,
  "name": "<string>",
  "owner_id": "<string>",
  "rate_limit": 123,
  "rate_limit_duration": 123,
  "secret": "<string>",
  "slack_webhook_url": "<string>",
  "support_email": "<string>",
  "url": "<string>"
}'
{
  "message": "<string>",
  "status": true,
  "data": {
    "advanced_signatures": true,
    "authentication": {
      "api_key": {
        "header_name": "<string>",
        "header_value": "<string>"
      },
      "type": "api_key"
    },
    "created_at": "<string>",
    "deleted_at": "<string>",
    "description": "<string>",
    "events": 123,
    "http_timeout": 123,
    "name": "<string>",
    "owner_id": "<string>",
    "project_id": "<string>",
    "rate_limit": 123,
    "rate_limit_duration": 123,
    "secrets": [
      {
        "created_at": "<string>",
        "deleted_at": "<string>",
        "expires_at": "<string>",
        "uid": "<string>",
        "updated_at": "<string>",
        "value": "<string>"
      }
    ],
    "slack_webhook_url": "<string>",
    "status": "active",
    "support_email": "<string>",
    "uid": "<string>",
    "updated_at": "<string>",
    "url": "<string>"
  }
}

Authorizations

Authorization
string
headerrequired

Path Parameters

projectID
string
required

Project ID

Body

application/json
advanced_signatures
boolean

Convoy supports two signature formats -- simple or advanced. If left unspecified, we default to false.

appID
string

Deprecated but necessary for backward compatibility

authentication
object

This is used to define any custom authentication required by the endpoint. This shouldn't be needed often because webhook endpoints usually should be exposed to the internet.

description
string

Human-readable description of the endpoint. Think of this as metadata describing the endpoint

http_timeout
integer

Define endpoint http timeout in seconds.

is_disabled
boolean

This is used to manually enable/disable the endpoint.

name
string

Endpoint name.

owner_id
string

The OwnerID is used to group more than one endpoint together to achieve fanout

rate_limit
integer

Rate limit is the total number of requests to be sent to an endpoint in the time duration specified in RateLimitDuration

rate_limit_duration
integer

Rate limit duration specifies the time range for the rate limit.

secret
string

Endpoint's webhook secret. If not provided, Convoy autogenerates one for the endpoint.

slack_webhook_url
string

Slack webhook URL is an alternative method to support email where endpoint developers can receive failure notifications on a slack channel.

support_email
string

Endpoint developers support email. This is used for communicating endpoint state changes. You should always turn this on when disabling endpoints are enabled.

url
string

URL is the endpoint's URL prefixed with https. non-https urls are currently not supported.

Response

200 - application/json
message
string
status
boolean
data
object

Was this page helpful?

List all endpointsRetrieve endpoint