Webhooks
Create a Webhook
POST
/
webhooks
curl --request POST \
--url https://api.sandbox.goteal.co/webhooks \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"name": "user-payroll-submitted",
"events": [
"user-payroll-submitted",
"user-payroll-created"
],
"url": "https://webhooks.company.com",
"signing_secret": "very-secret",
"encryption_key": "St/73LZ1xHkwX5TanL7V+YAVczn4acozPf3cFySKQXI=",
"config": {
"include_payload": true
}
}'
{
"webhook_id": "95a0e70b-fe02-4f47-aef9-2efff279df71",
"name": "user-payroll-submitted",
"events": [
"user-payroll-submitted",
"user-payroll-created"
],
"url": "https://webhooks.company.com",
"created_at": "2019-05-17T00:00:00.000Z"
}
Authorizations
Body
application/json
Response
201
application/json
Created
The response is of type object
.
curl --request POST \
--url https://api.sandbox.goteal.co/webhooks \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"name": "user-payroll-submitted",
"events": [
"user-payroll-submitted",
"user-payroll-created"
],
"url": "https://webhooks.company.com",
"signing_secret": "very-secret",
"encryption_key": "St/73LZ1xHkwX5TanL7V+YAVczn4acozPf3cFySKQXI=",
"config": {
"include_payload": true
}
}'
{
"webhook_id": "95a0e70b-fe02-4f47-aef9-2efff279df71",
"name": "user-payroll-submitted",
"events": [
"user-payroll-submitted",
"user-payroll-created"
],
"url": "https://webhooks.company.com",
"created_at": "2019-05-17T00:00:00.000Z"
}