Interline invitation

Events

Action Event name
create invitation (POST /interline/invitations) interlineinvitation.created
update invitation (PUT /interline/invitations/:interlineId) interlineinvitation.updated

Payload example created

{
  "attemptId": "310bb1cf-becd-4f12-bb49-a00133be22ec",
  "created": 1635870188,
  "data": {
    "_id": "618165e8df685b060a2fa9af",
    "accountId": "612e3e5a9afc794cdd77f8ff",
    "accountName": "Consumer Company",
    "createdAt": {
      "offset": 0,
      "value": "2021-11-02T16:23:04.109Z"
    },
    "createdBy": "612e3e5a9afc794cdd77f8f4",
    "enabled": false,
    "providerDomain": "providercompany.betterez.com",
    "providerEmail": "provider@company.com",
    "providerId": "52a377ec430c7d4e220001ff",
    "providerName": "Provider Company",
    "status": "pending",
    "updatedAt": {
      "offset": 0,
      "value": "2021-11-02T16:23:04.109Z"
    },
    "updatedBy": "612e3e5a9afc794cdd77f8f4"
  },
  "event": "interlineinvitation.created",
  "id": "b3dc6378-489c-4b39-b5ae-afc35f2747a4",
  "livemode": false
}

Payload fields (interlineinvitation.created)

Field Type Description
id string Webhook event id
attemptId string Delivery attempt id
created int Unix timestamp when the event was created
event string interlineinvitation.created
livemode boolean Whether the account is in live mode
data object The created invitation document
data._id string Interline invitation id (ObjectId)
data.accountId string Consumer account id
data.accountName string Consumer company name
data.providerId string Provider account id
data.providerName string Provider company name
data.providerEmail string Provider email
data.providerDomain string Provider domain
data.networkId string Network id (when created)
data.status string e.g. pending
data.enabled boolean
data.createdBy string User id that created the resource
data.updatedBy string User id that last updated the resource
data.createdAt object Creation date (value, offset)
data.updatedAt object Last update date (value, offset)

Payload example updated

{
  "attemptId": "aba96a02-9aaf-4345-8805-1caa0f76fbd1",
  "created": 1635877861,
  "data": {
    "_id": "6181833bdf685b060a2fa9bc",
    "accountId": "612e3e5a9afc794cdd77f8ff",
    "accountName": "Consumer Company",
    "createdAt": {
      "offset": 0,
      "value": "2021-11-02T18:28:11.546Z"
    },
    "createdBy": "612e3e5a9afc794cdd77f8f4",
    "enabled": false,
    "networkId": "618183bfc1149e0610d0ba93",
    "providerDomain": "providercompany.betterez.com",
    "providerEmail": "provider@company.com",
    "providerId": "52a377ec430c7d4e220001ff",
    "providerName": "Provider Company",
    "status": "approved",
    "updatedAt": {
      "offset": 0,
      "value": "2021-11-02T18:30:23.969Z"
    },
    "updatedBy": "60e2f9e02fe4c044072249d5"
  },
  "event": "interlineinvitation.updated",
  "id": "7b272521-1375-47e4-935f-4f5248bf86fc",
  "livemode": false
}

Payload fields (interlineinvitation.updated)

Field Type Description
id string Webhook event id
attemptId string Delivery attempt id
created int Unix timestamp when the event was created
event string interlineinvitation.updated
livemode boolean Whether the account is in live mode
data object The updated invitation document
data._id string Interline invitation id
data.accountId string Consumer account id
data.accountName string Consumer company name
data.providerId string Provider account id
data.providerName string Provider company name
data.providerEmail string Provider email
data.providerDomain string Provider domain
data.networkId string Network id (e.g. when accepted)
data.status string e.g. approved, rejected, pending
data.enabled boolean
data.createdBy string User id that created the resource
data.updatedBy string User id that last updated the resource
data.createdAt object Creation date (value, offset)
data.updatedAt object Last update date (value, offset)