POST
/
webhooks
/
trigger
Trigger an event
curl --request POST \
  --url https://api.synctera.com/v1/webhooks/trigger \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "event": "ADVERSE_ACTION.*"
}'
{
  "event_resource": "<string>",
  "event_resource_changed_fields": "<string>",
  "event_time": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "response_history": [
    {
      "code": 123,
      "response_body": "<string>",
      "response_time": "2023-11-07T05:31:56Z",
      "sent_time": "2023-11-07T05:31:56Z"
    }
  ],
  "status": "FAILED",
  "type": "ADVERSE_ACTION.CREATED",
  "url": "<string>",
  "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Provide an event type to trigger

​
event
Available options:
ADVERSE_ACTION.*,
APPLICATION.*,
CARD.*,
DISPUTE.*,
EXTERNAL_CARD.*,
EXTERNAL_CARD_TRANSFER.*,
INTERNAL_TRANSFER.*,
STATEMENT.*,
TRANSACTION.*

Response

Triggered webhook event

Webhook event object that will be returned after triggering the given event. Only id, type and event_time will have value.

​
event_resource
string
deprecated

Json string of object associated with the event. For example, if your event is ACCOUNT.CREATED, You can refer to Acccount to parse the account event to obtain the ID, status etc.

​
event_resource_changed_fields
string
deprecated

Json string of object associated with the event related to a resource change. This only contains those fields that have value changed on the event, and the field values are prior to the resource change event.

​
event_time
string<date-time>

Timestamp of the current event raised

​
id
string<uuid>

Unique event ID of the webhook request. Use event endpoints to get more event summary data

​
metadata
object
deprecated

Metadata that stored in the webhook subscription

​
resource_id
string<uuid>

The ID of the resource this event occurred on, if available.

​
response_history
Response history · object[]
deprecated

Response history of the webhook request

​
status
enum<string>
deprecated

Current event status. Failing event will keep retry until it is purged.

Available options:
FAILED,
RETRYING,
RUNNING,
SUCCESS
​
type
enum<string>

All the webhook event types

Available options:
ADVERSE_ACTION.CREATED,
APPLICATION.CREATED,
APPLICATION.UPDATED,
CARD.CREATED,
CARD.DIGITALWALLETTOKEN.CREATED,
CARD.DIGITALWALLETTOKEN.UPDATED,
CARD.IMAGE.CREATED,
CARD.IMAGE.UPDATED,
CARD.UPDATED,
DISPUTE.CREATED,
DISPUTE.UPDATED,
EXTERNAL_CARD.CREATED,
EXTERNAL_CARD.DELETED,
EXTERNAL_CARD.UPDATED,
EXTERNAL_CARD_TRANSFER.CREATED,
EXTERNAL_CARD_TRANSFER.UPDATED,
INTERNAL_TRANSFER.SUCCEEDED,
STATEMENT.CREATED,
TRANSACTION.CREATED,
TRANSACTION.UPDATED
​
url
string
deprecated

URL that the current event will be sent to

Maximum length: 1024
​
webhook_id
string<uuid>
deprecated

Webhook the current event belongs to