Skip to content
LionrapidLionrapid Docs

Create Endpoint

POST
/api/webhooks/endpoints
curl --request POST \
  --url https://app.lionrapid.com/api/webhooks/endpoints \
  --header 'Content-Type: application/json' \
  --data '{ "project_uuid": "example", "url": "example", "format": "generic", "events": [ "example" ], "namespaces": [ "example" ], "secret": "example" }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
CreateWebhookEndpointRequest
object
project_uuid
required
Project Uuid
string
url
required
Url
string
format
Format
string
default: generic
events
Events
Array<string>
namespaces
Namespaces
Array<string>
secret
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WebhookEndpointResponse

An endpoint WITH its secret. Returned by CREATE and ROTATE only — never by listing.

secret is the HMAC key for a generic receiver’s signature check, and is empty for a Slack endpoint, where the URL itself is the credential. The route is PM-gated.

object
endpoint_uuid
required
Endpoint Uuid
string
url
required
Url
string
format
required
Format
string
events
required
Events
Array<string>
namespaces
required
Namespaces
Array<string>
active
required
Active
boolean
created_at
required
Created At
number
last_delivery_channel
Any of:
string
last_delivery_outcome
Any of:
string
last_delivery_at
Any of:
number
last_delivery_ok_at
Any of:
number
consecutive_delivery_failures
Any of:
integer
secret
required
Secret
string
Examplegenerated
{
  "endpoint_uuid": "example",
  "url": "example",
  "format": "example",
  "events": [
    "example"
  ],
  "namespaces": [
    "example"
  ],
  "active": true,
  "created_at": 1,
  "last_delivery_channel": "example",
  "last_delivery_outcome": "example",
  "last_delivery_at": 1,
  "last_delivery_ok_at": 1,
  "consecutive_delivery_failures": 1,
  "secret": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}