Membership Period Activated | NaviPartner | NP Retail API Documentation

Event name membershipPeriod_activated

This webhook is triggered when a membership is activated. Use the Get Membership History endpoint to retrieve full details about the membership’s validity periods.

Payload

The payload of this webhook request is an object.

appIdUUIDRequired

clientStatestringRequired

companyIdUUIDRequired

companyNamestringRequired

eventNamestringRequired

eventVersionstringRequired

initiatingUserAADObjectIdstringRequired

payloadobjectRequired

timestampdatetimeRequired

Response

200

any

Return a 200 status to indicate that the data was received successfully.

1	{
2	"appId": "992c2309-cca4-43cb-9e41-911f482ec088",
3	"clientState": "secret_value_from_subscription_creation_mirrored",
4	"companyId": "b56a418d-8205-4d3a-bdbb-25d94e42abbd",
5	"companyName": "CRONUS International Ltd.",
6	"eventName": "membershipPeriod_activated",
7	"eventVersion": "1.0",
8	"initiatingUserAADObjectId": "ef546153-4168-4bd5-9365-a3161608da72",
9	"payload": {
10	"membershipId": "cdef7890-abcd-0123-1234-567890abcdef",
11	"entryId": "22349999-bbbb-cccc-dddd-2234567890bc"
12	},
13	"timestamp": "2024-06-28T12:00:00Z"
14	}