Create a webhook endpoint

POST

/webhooks

curl --request POST \
  --url https://api.invogi.com/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "url": "https://example.com", "events": [ "example" ] }'

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

url

required

string format: uri

events

required

Array<string>

Example ^generated

{
  "url": "https://example.com",
  "events": [
    "example"
  ]
}

Responses

201

Webhook endpoint created

Media typeapplication/json

object

id

required

string

url

required

string format: uri

enabled

required

boolean

events

Array<string>

Example ^generated

{
  "id": "example",
  "url": "https://example.com",
  "enabled": true,
  "events": [
    "example"
  ]
}

400

Invalid request

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "NOT_FOUND"
  }
}

401

Missing or invalid API key

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "NOT_FOUND"
  }
}