POST
/
webhooks
Create a webhook
curl --request POST \
  --url https://api.synctera.com/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>",
  "enabled_events": [
    "ADVERSE_ACTION.*"
  ],
  "is_enabled": true,
  "metadata": {},
  "tenant": "abcdef_ghijkl",
  "url": "<string>"
}'
{
  "creation_time": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "enabled_events": [
    "ADVERSE_ACTION.*"
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_enabled": true,
  "last_updated": "2023-11-07T05:31:56Z",
  "last_updated_time": "2023-11-07T05:31:56Z",
  "metadata": {},
  "tenant": "abcdef_ghijkl",
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Webhook to create

Webhook object

​
enabled_events
enum<string>[]
required

A list of the events that will trigger the webhook. Subscribing to a wildcard event, e.g. ACCOUNT.*, will send all webhooks for all events that match that pattern. Note that this can include new event types added after the subscription was created.

​
is_enabled
boolean
required

Set the webhook to be enabled or disabled

​
url
string<uri>
required

URL that the webhook will send request to

Maximum length: 1000
​
description
string

A description of what the webhook is used for

​
metadata
object

Additional information stored to the webhook

​
tenant
string

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

Response

Created webhook

Webhook object

​
enabled_events
enum<string>[]
required

A list of the events that will trigger the webhook. Subscribing to a wildcard event, e.g. ACCOUNT.*, will send all webhooks for all events that match that pattern. Note that this can include new event types added after the subscription was created.

​
is_enabled
boolean
required

Set the webhook to be enabled or disabled

​
url
string<uri>
required

URL that the webhook will send request to

Maximum length: 1000
​
creation_time
string<date-time>

Webhook creation timestamp in RFC3339 format

​
description
string

A description of what the webhook is used for

​
id
string<uuid>

The unique ID of the webhook

​
last_updated
string<date-time>

Timestamp that this webhook was created or the last time any field was changed

​
last_updated_time
string<date-time>

Timestamp of the last Webhook modification in RFC3339 format

​
metadata
object

Additional information stored to the webhook

​
tenant
string

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"