Events: Authentication

There are four event types around authentication:

  • credential-delete - emitted when a credential is deleted by a user
  • credential-auth - emitted when a new credential is authenticated by a user
  • credential-reauth - emitted when a credential’s authentication is refreshed by a user
  • credential-deauth - emitted when a credential has been identified as being expired and all attempts to refresh failed

Field

Type

Description

service

String

The social service the credential is for. Today, these include, but are not limited to:

  • Facebook
  • Instagram
  • YouTube
  • RSS

serviceId

String

The id of the account on the network.

name

String

The name of the account on the service.

when

Number

The time the event occurred in milliseconds since epoch.

message

String

The message about the event happening. Typically, this is simply success in that the event completed and was registered successfully.

Example payload:

{
  "service": "instagram",
  "serviceId": "673abc9794",
  "name": "will.i.am",
  "when": 1520987518000,
  "message": "success"
}

Did this page help you?