Add a webhook endpoint

POST

/v1/webhooks

Launch will POST to this URL when a subscribed event happens. Only public https:// URLs: no IP addresses, internal hostnames, credentials or custom ports, and redirects are not followed. The response carries signing_secret once; store it. format defaults to slack or discord for those incoming-webhook URLs (a readable message, since they reject anything else) and to json otherwise (the signed event envelope). Failed deliveries are retried after 1 minute, 5 minutes, 30 minutes, 2 hours and 6 hours; an endpoint that fails 20 deliveries in a row is switched off.

Auth: Secret key only. Indie: 2 endpoints per project, Builder: 5.

Authorizations

• SecretApiKey

Request Body ^required

object

url

required

string format: uri

Example

https://example.com/hooks/nordva

events

required

* subscribes to every event, including ones added later.

Array<string>

Allowed values: * waitlist.signup.created waitlist.signups.invited changelog.entry.published changelog.subscriber.created feedback.created

format

string

Allowed values: json slack discord

description

string

<= 200 characters

Responses

201

The endpoint, with signing_secret shown once

401

Error envelope. See error.code for the discriminator.

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties

403

Error envelope. See error.code for the discriminator.

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties

422

INVALID_WEBHOOK_URL

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties