LiveRecoverVYG Developer Docs
Brand Data API

Event definitions

List event definitions

GET/providers/{providerId}/event-definitions

List a provider's event definitions.

Authorization

bearerAuth
AuthorizationBearer <token>

Brand Data API key issued for your Custom E-Com integration, sent as Authorization: Bearer <key>.

In: header

Path Parameters

providerId*string

Provider id.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/providers/string/event-definitions"
{  "data": [    {      "id": "string",      "providerId": "string",      "type": "new_order",      "name": "New Order",      "description": "string",      "payloadSchema": null,      "identifierMappings": null,      "schemaVersion": 0,      "sourceTemplateKey": "string",      "isEnabled": true,      "createdAt": "string",      "updatedAt": "string"    }  ]}
{  "error": "string"}
{  "error": {    "code": "conversation_not_found",    "message": "string"  }}
{  "error": {    "code": "conversation_not_found",    "message": "string"  }}
{  "error": {    "code": "conversation_not_found",    "message": "string"  }}
{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

Create an event definition

POST/providers/{providerId}/event-definitions

Create an event definition on a provider. type must be a slug and unique per provider; payloadSchema must be compilable JSON Schema; identifierMappings must carry externalIdPath plus at least one of emailPath or phonePath.

Authorization

bearerAuth
AuthorizationBearer <token>

Brand Data API key issued for your Custom E-Com integration, sent as Authorization: Bearer <key>.

In: header

Path Parameters

providerId*string

Provider id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/providers/string/event-definitions" \  -H "Content-Type: application/json" \  -d '{    "type": "string",    "name": "string",    "payloadSchema": {      "property1": null,      "property2": null    },    "identifierMappings": {      "property1": null,      "property2": null    }  }'
{  "data": {    "id": "string",    "providerId": "string",    "type": "new_order",    "name": "New Order",    "description": "string",    "payloadSchema": null,    "identifierMappings": null,    "schemaVersion": 0,    "sourceTemplateKey": "string",    "isEnabled": true,    "createdAt": "string",    "updatedAt": "string"  }}
{  "error": {    "code": "conversation_not_found",    "message": "string"  }}
{  "error": "string"}
{  "error": {    "code": "conversation_not_found",    "message": "string"  }}
{  "error": {    "code": "conversation_not_found",    "message": "string"  }}
{  "error": {    "code": "conversation_not_found",    "message": "string"  }}
{  "error": {    "code": "conversation_not_found",    "message": "string"  }}
{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

Get an event definition

GET/providers/{providerId}/event-definitions/{definitionId}

Authorization

bearerAuth
AuthorizationBearer <token>

Brand Data API key issued for your Custom E-Com integration, sent as Authorization: Bearer <key>.

In: header

Path Parameters

providerId*string

Provider id.

definitionId*string

Event definition id.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/providers/string/event-definitions/string"
{  "data": {    "id": "string",    "providerId": "string",    "type": "new_order",    "name": "New Order",    "description": "string",    "payloadSchema": null,    "identifierMappings": null,    "schemaVersion": 0,    "sourceTemplateKey": "string",    "isEnabled": true,    "createdAt": "string",    "updatedAt": "string"  }}
{  "error": "string"}
{  "error": {    "code": "conversation_not_found",    "message": "string"  }}
{  "error": {    "code": "conversation_not_found",    "message": "string"  }}
{  "error": {    "code": "conversation_not_found",    "message": "string"  }}
{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

Update an event definition

PATCH/providers/{providerId}/event-definitions/{definitionId}

Sparse update. Renaming type also re-points this brand’s workflows AND the provider’s inbound type matchers, so ingestion keeps working. Changing payloadSchema bumps schemaVersion; pass the version you read and a concurrent change returns 409 rather than silently losing your update.

Authorization

bearerAuth
AuthorizationBearer <token>

Brand Data API key issued for your Custom E-Com integration, sent as Authorization: Bearer <key>.

In: header

Path Parameters

providerId*string

Provider id.

definitionId*string

Event definition id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/providers/string/event-definitions/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "id": "string",    "providerId": "string",    "type": "new_order",    "name": "New Order",    "description": "string",    "payloadSchema": null,    "identifierMappings": null,    "schemaVersion": 0,    "sourceTemplateKey": "string",    "isEnabled": true,    "createdAt": "string",    "updatedAt": "string"  }}
{  "error": {    "code": "conversation_not_found",    "message": "string"  }}
{  "error": "string"}
{  "error": {    "code": "conversation_not_found",    "message": "string"  }}
{  "error": {    "code": "conversation_not_found",    "message": "string"  }}
{  "error": {    "code": "conversation_not_found",    "message": "string"  }}
{  "error": {    "code": "conversation_not_found",    "message": "string"  }}
{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

Providers

Previous Page

Conversations

Next Page