POST
/
api
/
v1
/
webhook-endpoints
Add a Webhook Endpoint
curl --request POST \
  --url http://localhost:8080/api/v1/webhook-endpoints \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>"
}
'
{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "secret": "<string>",
  "url": "<string>",
  "venture_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Body

application/json
​
url
string
required

Response

Endpoint created; signing secret returned ONCE

Returned once at creation. The plaintext secret is shown ONCE.

​
created_at
string<date-time>
required
​
id
string<uuid>
required
​
secret
string
required

Plaintext signing secret — store it now; used to verify X-Signature.

​
status
enum<string>
required

Whether an endpoint receives deliveries.

Available options:
ACTIVE,
DISABLED
​
url
string
required
​
venture_id
string<uuid>
required