Webhooks

Get webhook stats

get

Get stats for a webhook

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

Stats for the webhook

application/json

successfulMessagesnumberRequired

The number of successful messages

Example: 100

failedMessagesnumberRequired

The number of failed messages

Example: 10

401Error

403Error

get

/webhooks/{id}/stats

GET /webhooks/{id}/stats HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "successfulMessages": 100,
  "failedMessages": 10
}

Get all webhooks

get

Get all webhooks for the current business

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

List of webhooks for the current business

application/json

idstringRequired

Unique identifier for the webhook

Example: 123e4567-e89b-12d3-a456-426614174000

urlstringRequired

The URL where webhook events will be sent

Example: https://example.com/webhooks

descriptionobjectRequired

Optional description for this webhook

isActivebooleanRequired

Whether the webhook is active

Example: true

createdAtstring · date-timeRequired

When the webhook was created

Example: 2023-01-01T00:00:00.000Z

updatedAtstring · date-timeRequired

When the webhook was last updated

Example: 2023-01-01T12:00:00.000Z

401Error

403Error

get

/webhooks

GET /webhooks HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "url": "https://example.com/webhooks",
    "description": {},
    "events": [
      "transaction.updated"
    ],
    "isActive": true,
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-01T12:00:00.000Z"
  }
]

Delete a webhook

delete

Delete a webhook for the current business

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

204

The webhook has been successfully deleted

401Error

403Error

404

The webhook with the given ID was not found

delete

/webhooks/{id}

DELETE /webhooks/{id} HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a webhook

patch

Update a webhook for the current business

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

urlstring · url · max: 2048Required

The URL where webhook events will be sent. Must be a valid URL with a TLD.

Example: https://example.com/webhooks

descriptionstring · max: 1000Optional

Optional description for this webhook

isActivebooleanOptional

Whether the webhook is active

Example: true

Responses

200

The webhook has been successfully updated

application/json

idstringRequired

Unique identifier for the webhook

Example: 123e4567-e89b-12d3-a456-426614174000

urlstringRequired

The URL where webhook events will be sent

Example: https://example.com/webhooks

descriptionobjectRequired

Optional description for this webhook

isActivebooleanRequired

Whether the webhook is active

Example: true

createdAtstring · date-timeRequired

When the webhook was created

Example: 2023-01-01T00:00:00.000Z

updatedAtstring · date-timeRequired

When the webhook was last updated

Example: 2023-01-01T12:00:00.000Z

401Error

403Error

404

The webhook with the given ID was not found

patch

/webhooks/{id}

PATCH /webhooks/{id} HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "url": "https://example.com/webhooks",
  "description": "text",
  "isActive": true
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "url": "https://example.com/webhooks",
  "description": {},
  "events": [
    "transaction.updated"
  ],
  "isActive": true,
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T12:00:00.000Z"
}

Get a webhook by id

get

Get a webhook by id

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

Returns the webhook with the given ID

application/json

idstringRequired

Unique identifier for the webhook

Example: 123e4567-e89b-12d3-a456-426614174000

urlstringRequired

The URL where webhook events will be sent

Example: https://example.com/webhooks

descriptionobjectRequired

Optional description for this webhook

isActivebooleanRequired

Whether the webhook is active

Example: true

createdAtstring · date-timeRequired

When the webhook was created

Example: 2023-01-01T00:00:00.000Z

updatedAtstring · date-timeRequired

When the webhook was last updated

Example: 2023-01-01T12:00:00.000Z

401Error

403Error

404

The webhook with the given ID was not found

get

/webhooks/{id}

GET /webhooks/{id} HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "url": "https://example.com/webhooks",
  "description": {},
  "events": [
    "transaction.updated"
  ],
  "isActive": true,
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T12:00:00.000Z"
}

Create a new webhook

post

Create a new webhook for the current business

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

urlstring · url · max: 2048Required

The URL where webhook events will be sent. Must be a valid URL with a TLD.

Example: https://example.com/webhooks

descriptionstring · max: 1000Optional

Optional description for this webhook

isActivebooleanOptional

Whether the webhook is active

Default: trueExample: true

Responses

201

The webhook has been successfully created.

application/json

401Error

403Error

post

/webhooks

POST /webhooks HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "url": "https://example.com/webhooks",
  "description": "text",
  "events": [
    "transaction.updated"
  ],
  "isActive": true
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "url": "https://example.com/webhooks",
  "description": {},
  "events": [
    "transaction.updated"
  ],
  "isActive": true,
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T12:00:00.000Z"
}

Get all supported webhook events

get

Get all supported webhook events

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

List of supported webhook events

application/json

eventsstring[]Required

List of supported webhook events

Example: ["transaction.updated"]

401Error

403Error

get

/webhooks/events

GET /webhooks/events HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "events": [
    "transaction.updated"
  ]
}

Get all attempts for a webhook

get

Get all attempts for a webhook

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

List of attempts for a webhook

application/json

urlstringRequired

The URL where the webhook was sent

Example: https://example.com/webhook/

responsestringRequired

Response body from the webhook endpoint

Example: {}

responseStatusCodenumberRequired

HTTP status code of the response

Example: 200

statusall ofRequired

Status of the webhook attempt

Example: SUCCESS

string · enumOptional

Status of the webhook attempt

Possible values:

msgIdstringRequired

Message ID

Example: msg_1srOrx2ZWZBpBUvZwXKQmoEYga2

idstringRequired

Unique identifier for the attempt

Example: atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2

timestampstring · date-timeRequired

Timestamp when the attempt was made

Example: 2019-08-24T14:15:22Z

401Error

403Error

get

/webhooks/{id}/attempts

GET /webhooks/{id}/attempts HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "url": "https://example.com/webhook/",
  "response": "{}",
  "responseStatusCode": 200,
  "status": "SUCCESS",
  "msgId": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2",
  "id": "atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2",
  "timestamp": "2019-08-24T14:15:22Z",
  "msg": {
    "eventType": "transaction.updated",
    "payload": {},
    "id": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Send example message

post

Send example message to a webhook

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

eventTypestringRequired

The event type to send

Example: transaction.updated

Responses

201

The message ID

application/json

401Error

403Error

post

/webhooks/{id}/send-example

POST /webhooks/{id}/send-example HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "eventType": "transaction.updated"
}

{
  "messageId": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2"
}

Get endpoint secret

get

Get the secret for a webhook endpoint

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

The secret for the webhook endpoint

application/json

stringOptional

401Error

403Error

get

/webhooks/{id}/secret

GET /webhooks/{id}/secret HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

Webhook Events | LiveEO · Svixwww.svix.com

PreviousSurvey responses NextHealth

Last updated 7 months ago

hashtagGet webhook stats

hashtagGet all webhooks

hashtagDelete a webhook

hashtagUpdate a webhook

hashtagGet a webhook by id

hashtagCreate a new webhook

hashtagGet all supported webhook events

hashtagGet all attempts for a webhook

hashtagSend example message

hashtagGet endpoint secret

Get webhook stats

Get all webhooks

Delete a webhook

Update a webhook

Get a webhook by id

Create a new webhook

Get all supported webhook events

Get all attempts for a webhook

Send example message

Get endpoint secret