@nht-pandats/sdk / @nht-pandats/sdk/clients / @nht-pandats/sdk/clients/affiliateApi / AffiliateApiCallbacksModelDefinition

Interface: AffiliateApiCallbacksModelDefinition

@nht-pandats/sdk/clients.@nht-pandats/sdk/clients/affiliateApi.AffiliateApiCallbacksModelDefinition

The model definition for a callback in the Affiliate API.

Since

v1.20240429.0

Hierarchy

• ModuleModelDefinition

  ↳ AffiliateApiCallbacksModelDefinition

Properties

event

• event: Object

The event that the callback is triggered for

Type declaration

Name	Type
filters	{ contain: true ; match: true }
filters.contain	true
filters.match	true
inCreatePayload	false
inResponsePayload	true
inUpdatePayload	true
requiredInCreatePayload	false
requiredInUpdatePayload	true
type	"ftd" | "convert_lead"

filters: { contain: true ; match: true }

-

---

filters.contain: true

-

---

filters.match: true

-

---

inCreatePayload: false

-

---

inResponsePayload: true

-

---

inUpdatePayload: true

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: true

-

---

type: "ftd" | "convert_lead"

-

---

Defined in

src/clients/affiliateApi/callbacks.ts:16

---

url

• url: Object

The callback's url

Type declaration

Name	Type
inCreatePayload	false
inResponsePayload	true
inUpdatePayload	true
requiredInCreatePayload	false
requiredInUpdatePayload	true
type	string

inCreatePayload: false

-

---

inResponsePayload: true

-

---

inUpdatePayload: true

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: true

-

---

type: string

-

---

Defined in

src/clients/affiliateApi/callbacks.ts:31