Skip to main content
GET
/
webhooks
/
{webhook_id}
Returns a webhook.
curl --request GET \
  --url https://api.sandbox.goteal.co/webhooks/{webhook_id} \
  --header 'X-API-KEY: <api-key>'
{
  "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"
}

Documentation Index

Fetch the complete documentation index at: https://docs.goteal.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
webhook_id
string
required

ID of the webhook to get

Response

OK

​
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"