Skip to main content
POST
/
webhooks
Creates a webhook.
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-hmrc-data-submitted",
    "user-bank-statement-submitted"
  ],
  "url": "https://webhooks.company.com",
  "signing_secret": "very-secret",
  "encryption_key": "St/73LZ1xHkwX5TanL7V+YAVczn4acozPf3cFySKQXI=",
  "config": {
    "include_payload": true
  }
}
'
import requests

url = "https://api.sandbox.goteal.co/webhooks"

payload = {
"name": "user-payroll-submitted",
"events": ["user-payroll-submitted", "user-hmrc-data-submitted", "user-bank-statement-submitted"],
"url": "https://webhooks.company.com",
"signing_secret": "very-secret",
"encryption_key": "St/73LZ1xHkwX5TanL7V+YAVczn4acozPf3cFySKQXI=",
"config": { "include_payload": True }
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'user-payroll-submitted',
events: [
'user-payroll-submitted',
'user-hmrc-data-submitted',
'user-bank-statement-submitted'
],
url: 'https://webhooks.company.com',
signing_secret: 'very-secret',
encryption_key: 'St/73LZ1xHkwX5TanL7V+YAVczn4acozPf3cFySKQXI=',
config: {include_payload: true}
})
};

fetch('https://api.sandbox.goteal.co/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.goteal.co/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'user-payroll-submitted',
'events' => [
'user-payroll-submitted',
'user-hmrc-data-submitted',
'user-bank-statement-submitted'
],
'url' => 'https://webhooks.company.com',
'signing_secret' => 'very-secret',
'encryption_key' => 'St/73LZ1xHkwX5TanL7V+YAVczn4acozPf3cFySKQXI=',
'config' => [
'include_payload' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.sandbox.goteal.co/webhooks"

payload := strings.NewReader("{\n \"name\": \"user-payroll-submitted\",\n \"events\": [\n \"user-payroll-submitted\",\n \"user-hmrc-data-submitted\",\n \"user-bank-statement-submitted\"\n ],\n \"url\": \"https://webhooks.company.com\",\n \"signing_secret\": \"very-secret\",\n \"encryption_key\": \"St/73LZ1xHkwX5TanL7V+YAVczn4acozPf3cFySKQXI=\",\n \"config\": {\n \"include_payload\": true\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.sandbox.goteal.co/webhooks")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"user-payroll-submitted\",\n \"events\": [\n \"user-payroll-submitted\",\n \"user-hmrc-data-submitted\",\n \"user-bank-statement-submitted\"\n ],\n \"url\": \"https://webhooks.company.com\",\n \"signing_secret\": \"very-secret\",\n \"encryption_key\": \"St/73LZ1xHkwX5TanL7V+YAVczn4acozPf3cFySKQXI=\",\n \"config\": {\n \"include_payload\": true\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.sandbox.goteal.co/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"user-payroll-submitted\",\n \"events\": [\n \"user-payroll-submitted\",\n \"user-hmrc-data-submitted\",\n \"user-bank-statement-submitted\"\n ],\n \"url\": \"https://webhooks.company.com\",\n \"signing_secret\": \"very-secret\",\n \"encryption_key\": \"St/73LZ1xHkwX5TanL7V+YAVczn4acozPf3cFySKQXI=\",\n \"config\": {\n \"include_payload\": true\n }\n}"

response = http.request(request)
puts response.read_body
{
  "webhook_id": "95a0e70b-fe02-4f47-aef9-2efff279df71",
  "name": "user-payroll-submitted",
  "events": [
    "user-payroll-submitted",
    "user-hmrc-data-submitted",
    "user-bank-statement-submitted"
  ],
  "url": "https://webhooks.company.com",
  "created_at": "2019-05-17T00:00:00.000Z"
}
{
"errors": [
"The request is missing the required field `name`"
]
}
{
"errors": [
"No X-API-KEY header provided or wrong value"
]
}

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:
[
"user-payroll-submitted",
"user-hmrc-data-submitted",
"user-bank-statement-submitted"
]
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:
[
"user-payroll-submitted",
"user-hmrc-data-submitted",
"user-bank-statement-submitted"
]
url
string<url>
required
Example:

"https://webhooks.company.com"

created_at
string<date-time>
required
Example:

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