Skip to content
ReflexDB

Create webhook subscription

POST
/databases/{id}/webhooks
 
curl --request POST \
  --url https://api.reflexdb.cloud/v1/databases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "url": "https://example.com", "eventTypes": [ "build.completed" ] }'

Subscribes an HTTPS endpoint to one or more platform events. The HMAC-SHA256 signing secret is returned once in the secret field. Deliveries are signed with X-ReflexDB-Signature: sha256=<hex>.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

Database ID

Request Body required

Section titled “Request Body required ”
Media type application/json
CreateWebhookBody
object
url
required

HTTPS endpoint that will receive signed POST requests

string format: uri
eventTypes
required
Array<string>
>= 1 items <= 4 items
Allowed values: build.completed build.failed instance.unhealthy instance.recovered

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Newly created webhook — HMAC signing secret shown once, cannot be retrieved again

Media type application/json
CreatedWebhookSubscription

Newly created webhook — HMAC signing secret shown once, cannot be retrieved again

object
id
required
string format: uuid
databaseId
required
string format: uuid
url
required
string format: uri
eventTypes
required
Array<string>
Allowed values: build.completed build.failed instance.unhealthy instance.recovered
enabled
required
boolean
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
secret
required

32-byte hex HMAC-SHA256 signing secret. Use X-ReflexDB-Signature header to verify deliveries.

string
Example 
{
  "eventTypes": [
    "build.completed"
  ]
}

400

Section titled “400 ”

Default Response

Media type application/json
Error
object
error
required
string
message
string
Example generated
{
  "error": "example",
  "message": "example"
}

403

Section titled “403 ”

Default Response

Media type application/json
Error
object
error
required
string
message
string
Example generated
{
  "error": "example",
  "message": "example"
}

404

Section titled “404 ”

Default Response

Media type application/json
Error
object
error
required
string
message
string
Example generated
{
  "error": "example",
  "message": "example"
}

409

Section titled “409 ”

Default Response

Media type application/json
Error
object
error
required
string
message
string
Example generated
{
  "error": "example",
  "message": "example"
}