Skip to main content
PUT
/
webhooks
/
{webhook_id}
Update a webhook
curl --request PUT \
  --url https://api.synctera.com/v2/webhooks/{webhook_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled_events": [
    "ACCOUNT.CREATED"
  ],
  "is_enabled": true,
  "url": "<string>",
  "description": "<string>",
  "metadata": "<string>",
  "tenant": "abcdef_ghijkl"
}
'
{
  "enabled_events": [
    "ACCOUNT.CREATED"
  ],
  "is_enabled": true,
  "url": "<string>",
  "description": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_updated": "2023-11-07T05:31:56Z",
  "metadata": "<string>",
  "tenant": "abcdef_ghijkl"
}

Path Parameters

​
webhook_id
string<uuid>
required

Webhook ID

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

Body

application/json

Webhook to update

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.

All the webhook event types

Available options:
ACCOUNT.CREATED,
ACCOUNT.UPDATED,
ADDRESS.CREATED,
ADDRESS.UPDATED,
ACH.INCOMING.FUTURE_DATED,
APPLICATION.CREATED,
APPLICATION.UPDATED,
BUSINESS.CREATED,
BUSINESS.UPDATED,
BUSINESS.VERIFICATION_OUTCOME.UPDATED,
CARD.CREATED,
CARD.DIGITALWALLETTOKEN.CREATED,
CARD.DIGITALWALLETTOKEN.UPDATED,
CARD.IMAGE.UPDATED,
CARD.THREE_DS.DECISION,
CARD.THREE_DS.AUTHENTICATION,
CARD.UPDATED,
CASE.CREATED,
CASE.UPDATED,
CASH_PICKUP.CREATED,
CASH_PICKUP.UPDATED,
CREDIT_SCORE.CREATED,
CUSTOMER.CREATED,
CUSTOMER.KYC_OUTCOME.UPDATED,
CUSTOMER.UPDATED,
EXTERNAL_CARD_TRANSFER.CREATED,
EXTERNAL_CARD_TRANSFER.UPDATED,
EXTERNAL_CARD.CREATED,
EXTERNAL_CARD.DELETED,
EXTERNAL_CARD.UPDATED,
INTEREST.MONTHLY_PAYOUT,
INTERNAL_ACCOUNT.CREATED,
INTERNAL_ACCOUNT.UPDATED,
INTERNAL_TRANSFER.SUCCEEDED,
NOTE.CREATED,
NOTE.UPDATED,
PAYMENT_SCHEDULE.CREATED,
PAYMENT_SCHEDULE.PAYMENT.CREATED,
PAYMENT_SCHEDULE.UPDATED,
PERSON.CREATED,
PERSON.UPDATED,
PERSON.VERIFICATION_OUTCOME.UPDATED,
STATEMENT.CREATED,
TRANSACTION.PENDING.CREATED,
TRANSACTION.PENDING.UPDATED,
TRANSACTION.POSTED.CREATED,
TRANSACTION.POSTED.UPDATED
​
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 string length: 1000
​
description
string

A description of what the webhook is used for

​
metadata
string

Additional information stored to the webhook

Maximum string length: 1024
​
tenant
string

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

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.

All the webhook event types

Available options:
ACCOUNT.CREATED,
ACCOUNT.UPDATED,
ADDRESS.CREATED,
ADDRESS.UPDATED,
ACH.INCOMING.FUTURE_DATED,
APPLICATION.CREATED,
APPLICATION.UPDATED,
BUSINESS.CREATED,
BUSINESS.UPDATED,
BUSINESS.VERIFICATION_OUTCOME.UPDATED,
CARD.CREATED,
CARD.DIGITALWALLETTOKEN.CREATED,
CARD.DIGITALWALLETTOKEN.UPDATED,
CARD.IMAGE.UPDATED,
CARD.THREE_DS.DECISION,
CARD.THREE_DS.AUTHENTICATION,
CARD.UPDATED,
CASE.CREATED,
CASE.UPDATED,
CASH_PICKUP.CREATED,
CASH_PICKUP.UPDATED,
CREDIT_SCORE.CREATED,
CUSTOMER.CREATED,
CUSTOMER.KYC_OUTCOME.UPDATED,
CUSTOMER.UPDATED,
EXTERNAL_CARD_TRANSFER.CREATED,
EXTERNAL_CARD_TRANSFER.UPDATED,
EXTERNAL_CARD.CREATED,
EXTERNAL_CARD.DELETED,
EXTERNAL_CARD.UPDATED,
INTEREST.MONTHLY_PAYOUT,
INTERNAL_ACCOUNT.CREATED,
INTERNAL_ACCOUNT.UPDATED,
INTERNAL_TRANSFER.SUCCEEDED,
NOTE.CREATED,
NOTE.UPDATED,
PAYMENT_SCHEDULE.CREATED,
PAYMENT_SCHEDULE.PAYMENT.CREATED,
PAYMENT_SCHEDULE.UPDATED,
PERSON.CREATED,
PERSON.UPDATED,
PERSON.VERIFICATION_OUTCOME.UPDATED,
STATEMENT.CREATED,
TRANSACTION.PENDING.CREATED,
TRANSACTION.PENDING.UPDATED,
TRANSACTION.POSTED.CREATED,
TRANSACTION.POSTED.UPDATED
​
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 string length: 1000
​
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

​
metadata
string

Additional information stored to the webhook

Maximum string length: 1024
​
tenant
string

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"