Connections
On this page, we’ll look into how you can connect your users to the Notify app.
The connection model
Connections represent a relationship between your user's mobile device, and their record in your application. You simply provide a unique identifier for the user, and we handle the rest.
Properties
- Name
id- Type
- string
- Description
Unique identifier for the connection.
- Name
user_id- Type
- string
- Description
The unique identifier you provided when creating the connection intent.
- Name
status- Type
- enum
- Description
The current state of the connection. Possible values are
active,pausedandarchived.
Create an intent
The first step in the connection process is to create an intent. It's a unique URL you provide a user via a QR Code or link. When the user navigates to the link, they'll be taken to the Notify app and create the connection automatically.
Required attributes
- Name
user_id- Type
- string
- Description
A unique identifier for the user. This can be anything you like, but it must be unique to the user.
Request
curl --request GET \
--url 'https://usenotify.app/api/v1/intent?user_id=${user_id}' \
--header 'Authorization: {token}' \
--header 'Content-Type: application/json'
Response
{
"image_url": "https://usenotify.app/api/qr?data=https://notify-dev.app.link/gfuHOWSKrBb?key={base64_encoded_key}",
"raw_value": "{base64_encoded_key}",
"direct_link": "https://notify-dev.app.link/gfuHOWSKrBb?key={base64_encoded_key}"
}
Response
{
"message": "No user_id provided"
}
To learn more about the process of connecting your users, check out Quickstart guide.