Legacy events

08 Aug 2023
6 Minutes to read

Legacy events

Updated on 08 Aug 2023
6 Minutes to read

Article summary

Did you find this summary helpful?

Thank you for your feedback

Introduction

The payload of an event will consist of two parts:

General fields
Event specific fields, nested within the detail field

The general fields of an event are described below.

Field	Type	Description
version	String	Version of the event, typically set to 0.
id	String	Unique identfier of the event.
detail-type	String	Type of the event.
source	String	Originating system of the event. For events originating from Connect, the value will be no.mediaconnect.connect
account	String	AWS account number.
time	String	Timestamp of the event.
region	String	AWS region that sent the event.
resources	String array	AWS resources involved in the event. This field will typically be an empty array.
detail	JSON object	Event specific fields.

Subscription start event

Event type

SUBSCRIPTION_START

Description

This event is generated by Connect when a new subscription product is started on a customer. This means that the specified customer has become active on the given product.

Event specific fields

Field	Type	Description	Nullable
schema	String	Identifier of Connect schema that generated the event.	No
customer	Integer	Connect customer number related to the event.	No
product	String	Product code of the subscription that has started.	No
periodEnd	Integer	Epoch timestamp in milliseconds for end of current subscription period.	Yes

Example payload

{
  "version": "0",
  "id": "44e4dfe0-fb98-536d-0d55-a16b7770d1ae",
  "detail-type": "SUBSCRIPTION_START",
  "source": "no.mediaconnect.connect",
  "account": "408193426112",
  "time": "2022-01-19T13:07:17Z",
  "region": "eu-north-1",
  "resources": [],
  "detail": {
    "schema": "CNxx",
    "customer": 12345,
    "product": "PROD1",
    "periodEnd": 1610665200000
  }
}

Subscription stop event

Event type

SUBSCRIPTION_STOP

Description

This event is generated by Connect when a subscription product is stopped on a customer. This means that the specified customer has become passive on the given product.

Event specific fields

Field	Type	Description	Nullable
schema	String	Identifier of Connect schema that generated the event.	No
customer	Integer	Connect customer number related to the event.	No
product	String	Product code of the subscription that has stopped.	No

Example payload

{
  "version": "0",
  "id": "44e4dfe0-fb98-536d-0d55-a16b7770d1ae",
  "detail-type": "SUBSCRIPTION_STOP",
  "source": "no.mediaconnect.connect",
  "account": "408193426112",
  "time": "2022-01-19T13:07:17Z",
  "region": "eu-north-1",
  "resources": [],
  "detail": {
    "schema": "CNxx",
    "customer": 12345,
    "product": "PROD1"
  }
}

Subscription renewal event

Event type

SUBSCRIPTION_RENEW

Description

This event is generated by Connect when a subscription product has been renewed on a customer. This implies that the renewal counter for the product (smsm.rencount) has been increased.

Event specific fields

Field	Type	Description	Nullable
schema	String	Identifier of Connect schema that generated the event.	No
customer	Integer	Connect customer number related to the event.	No
product	String	Product code of the subscription that has been renewed.	No
periodEnd	Integer	Epoch timestamp in milliseconds for end of current subscription period.	Yes

Example payload

{
  "version": "0",
  "id": "44e4dfe0-fb98-536d-0d55-a16b7770d1ae",
  "detail-type": "SUBSCRIPTION_RENEW",
  "source": "no.mediaconnect.connect",
  "account": "408193426112",
  "time": "2022-01-19T13:07:17Z",
  "region": "eu-north-1",
  "resources": [],
  "detail": {
    "schema": "CNxx",
    "customer": 12345,
    "product": "PROD1",
    "periodEnd": 1610665200000
  }
}

Subscription stop reset event

Event type

SUBSCRIPTION_STOP_RESET

Description

This event is generated by Connect when a stopped subscription product is restarted on a customer. This means that the specified customer has been reactivated on the given product.

Event specific fields

Field	Type	Description	Nullable
schema	String	Identifier of Connect schema that generated the event.	No
customer	Integer	Connect customer number related to the event.	No
product	String	Product code of the subscription that has started.	No
periodEnd	Integer	Epoch timestamp in milliseconds for end of current subscription period.	Yes

Example payload

{
  "version": "0",
  "id": "734035b3-b2e0-115f-c3e0-3355d5dc438a",
  "detail-type": "SUBSCRIPTION_STOP_RESET",
  "source": "no.mediaconnect.connect",
  "account": "408193426112",
  "time": "2022-07-07T13:24:29Z",
  "region": "eu-north-1",
  "resources": [],
  "detail": {
    "schema": "CNxx",
    "customer": 12345,
    "product": "PROD1",
    "periodEnd": 1610665200000
  }
}

Order verification event

Event type

ORDER_VERIFICATION

Description

This event is generated when the verification process of an order is initiated.

Event specific fields

Field	Type	Description	Nullable
schema	String	Identifier of Connect schema that generated the event.	No
receivers	Integer array	List of Connect customer numbers that are receivers in the order. This will be empty if payer is the same as the receiver.	Yes
payer	Integer	Connect customer number of the payer of the order.	Yes
connectOrderNumber	Integer	Connect order number.	No
cidOrderNumber	Integer	ConnectID order number.	Yes
status	String	Status code for the order. See description here.	Yes

Example payload

{
  "version": "0",
  "id": "44e4dfe0-fb98-536d-0d55-a16b7770d1ae",
  "detail-type": "ORDER_VERIFICATION",
  "source": "no.mediaconnect.connect",
  "account": "408193426112",
  "time": "2022-01-19T13:07:17Z",
  "region": "eu-north-1",
  "resources": [],
  "detail": {
    "schema": "CNxx",
    "receivers": [
      23456,
      34567
    ],
    "payer": 12345,
    "connectOrderNumber": 54321,
    "cidOrderNumber": 24680,
    "status": "B"
  }
}

Order processed event

Event type

ORDER_PROCESSED

Description

This event is generated when the verification process of an order is processed.

Event specific fields

Field	Type	Description	Nullable
schema	String	Identifier of Connect schema that generated the event.	No
receivers	Integer array	List of Connect customer numbers that are receivers in the order. This will be empty if payer is the same as the receiver.	No
payer	Integer	Connect customer number of the payer of the order.	No
connectOrderNumber	Integer	Connect order number.	No
cidOrderNumber	Integer	ConnectID order number.	No
status	String	Status code for the order. See description here.	No

Example payload

{
  "version": "0",
  "id": "44e4dfe0-fb98-536d-0d55-a16b7770d1ae",
  "detail-type": "ORDER_PROCESSED",
  "source": "no.mediaconnect.connect",
  "account": "408193426112",
  "time": "2022-01-19T13:07:17Z",
  "region": "eu-north-1",
  "resources": [],
  "detail": {
    "schema": "CNxx",
    "receivers": [
      23456,
      34567
    ],
    "payer": 12345,
    "connectOrderNumber": 54321,
    "cidOrderNumber": 24680,
    "status": "B"
  }
}

Customer data changed

Event type

CUSTOMER_DATA_CHANGED

Description

The event will be generated and sent to EventBrigde if customer data has been changed. This means the event will be trigged by a change of name, address, email address, or phone numbers.

Event specific fields

Field	Type	Description	Nullable
schema	String	Identifier of Connect schema that generated the event.	No
customer	Integer	Customer number	No
name	object	Object of Name	No
firstName	String	Customer first name	Yes
middleName	String	Customer middle name	Yes
lastName	String	Customer last name	Yes
companyName	String	Name of the company	Yes
departmentName	String	department name	Yes
phoneNumbers	object array	Object of phone number	No
phoneNumber	String	The phone number, following standard E.164	Yes
phoneNumberType	String	Phone number type: Company, Personal, Fax	Yes
emails	String array	Email address	No
address	String	Object of address	No
addressType	String	There are three adresseType: currentAddress, historicalAddress, futureAddress	No
streetAddress	String	The street for this address	Yes
streetNumber	String	The street number for this address	Yes
entrance	String	The entrance for this address	Yes
floor	String	The floor for this address	Yes
postalCode	String	The postal code for this address	Yes
postalPlace	String	The postal place for this address	Yes
postalAddress	String	The postal address for this address	Yes
countryCode	String	The country code for this address - ISO 3166 - alpha-2	Yes

Example payload

{
  "version": "0",
  "id": "26bbc183-2c4a-00b1-0092-5d46653bef3f",
  "detail-type": "CUSTOMER_DATA_CHANGED",
  "source": "no.mediaconnect.connect",
  "account": "408193426112",
  "time": "2022-03-09T13:23:34Z",
  "region": "eu-north-1",
  "resources": [],
  "detail": {
    "schema": "CNDEV",
    "customer": 3,
    "name": {
      "firstName": "John",
      "middleName": "Middle",
      "lastName": "Doe",
      "companyName": "Mediaconnect",
      "departmentName": "Devops"
    },
    "phoneNumbers": [
      {
        "phoneNumber": "+4711122333",
        "phoneNumberType": "personal"
      },
      {
        "phoneNumber": "+4711133444",
        "phoneNumberType": "company"
      }
    ],
    "emails": [
      "email1@mediaconnnect.no",
      "email2@mediaconnect.no"
    ],
    "address": {
      "addressType": "currentAddress",
      "streetAddress": "Storgt.",
      "streetNumber": 56,
      "entrance": "A",
      "floor": 2,
      "postalCode": "2016",
      "postalPlace": "Oslo",
      "postalAddress": "Pb 265 Økern",
      "countryCode": "NO"
    }
  }
}

Order status codes

The following status codes are used on Connect orders.

Code	Description
A	Preliminary order (not yet confirmed by the merchant service provider).
B	Confirmed order, initial status for most orders.
C	Order updated in client schema.
D	An error occurred on this order.
G	Duplicate order.
H	Wrong coupon code or number.
I	Error creating a name and/or address.
J	Error creating recurring product.
K	This order should not be processed.
L	This order needs to be processed manually.
M	This order has been processed manually.
N	Error due to active gift subscription.
O	Error due to active gift subscription, email sent.
P	Error when handling prepaid/single credit card.

What's Next

Google analytics

Table of contents

Introduction
Subscription start event
Subscription stop event
Subscription renewal event
Subscription stop reset event
Order verification event
Order processed event
Customer data changed
Order status codes