Skip to main content
POST
Creates a webhook.

Authorizations

X-API-KEY
string
header
required

Body

application/json
name
string
required

A unique name of the webhook

Example:

"user-payroll-submitted"

events
string[]
required
Example:
url
string<url>
required
Example:

"https://webhooks.company.com"

signing_secret
string
write-only

A secret to sign the body of the webhook as described at "https://docs.goteal.co"

Example:

"very-secret"

encryption_key
string
write-only

A randomly generated 32-byte key, encoded in Base64, used to encrypt messages. This key is necessary for encryption but is not retrievable after being set.

Example:

"St/73LZ1xHkwX5TanL7V+YAVczn4acozPf3cFySKQXI="

config
object
write-only

Configuration properties of the webhook

Response

Created

webhook_id
string
required

The id of the webhook

Example:

"95a0e70b-fe02-4f47-aef9-2efff279df71"

name
string
required

A unique name of the webhook

Example:

"user-payroll-submitted"

events
string[]
required
Example:
url
string<url>
required
Example:

"https://webhooks.company.com"

created_at
string<date-time>
required
Example:

"2019-05-17T00:00:00.000Z"