Feature Overview

The Messaging API is responsible for messaging interactions related to email, Push Protocol or XMTP.

Authenticated endpoint overview

This API uses signed messages to validate a given wallet is authorized to submit the request. Authentication headers must be provided using the approach described below.

How to authenticate

• Determine the message that must be signed through the message generator endpoint
  • Request GET /api/user/{domain}/signature?device=true&expiry={timestamp}
    • Replace '{domain}' with desired domain
    • Replace '{expiry}' with desired Unix epoch timestamp
  • Response contains the message that must be signed
    • Message is a unique hash value
    • Represents combination of provided request parameters
    • Includes an expiration timestamp
• User must sign the message returned by the message generator API
  • For example, the Metamask wallet could be used to sign the message
  • Generated signature is used in header of subsequent GET or POST request
• Construct a request to the desired endpoint that requires user authentication
  • Must include headers
    • x-auth-domain - Must equal the {domain} in context
    • x-auth-expiration - Must equal the {expiry} timestamp in the signed message
    • x-auth-signature - Must be set to the value of the user generated signature