Skip to main content
Let’s see what the entire flow from Sign up to Results would look like. For this example, we will look at the use-case of a client trying to:
  • Connect to their end-users’ accounts on medical portals
  • Retrieve specific data
  • Update the payment information

​
Step 1: Make a free account

If it hasn’t been done already, you will first need to create a free account.
This will generate an Client ID and Sandbox secret in your API Keys page of your Dashboard. You will need these to make calls to our API Endpoints (Steps 5 and 6).

​
Step 2: Create your Link

Go to the Links page, and click the “New Link” button. Browse the Links via keywords, or create your own using the Link Builder. For more details on how to do this, please refer to the Links page. For this example, we will be using a public template called “Pay medical bill / set up payment plan” Pay medical bill template Note: Don’t forget to click “Create Link” to copy the Link into your account’s Link page.

​
Step 3: Review your Link

After the Link has been created, you will be redirected to the details of your Link. Check that:
  1. You have all the input information to make the jobs work.
  2. All the sources you want to connect to are listed. You can add or remove sources from the Sources tab.
  3. The Widget displays what you expect. You can see a preview from the Widget tab.
  4. Your webhook URL is properly set.
Let’s take FetchPaymentMethods for example: FetchPaymentMethods details
  1. The inputs required are Access Token (from EnsureConnection) and account_id (from your user/a database/FetchAccounts job) to run FetchPaymentMethods.
FetchPaymentMethods inputs
  1. The current source supported is Aetna. You can add more with the “Add Existing” button, which will list all the sources supported by Deck. If the one you want isn’t in the list, you can add it with the “Create New” button.
FetchPaymentMethods sources
  1. The Widget displays the expected list of sources.
FetchPaymentMethods widget
  1. The Webhook URL is properly set.
FetchPaymentMethods webhook

​
Step 4: Setup your Webhook handler

For testing purposes, we encourage you to quickly create a svix url to receive your test webhooks.

​
Step 5: Call EnsureConnection

EnsureConnection is very unique as a Job. It needs to be run first, as it is essential you get your Access Token to run the other jobs. You have two ways of doing so:
  • Use the Widget by clicking Widget Demo in the EnsureConnection job details.
  • Trigger webhooks programmatically according to Quickstart examples
curl --location 'https://sandbox.deck.co/api/v1/jobs/submit' \
--header 'x-deck-client-id: $YOUR_DECK_CLIENT_ID' \
--header 'x-deck-secret: $YOUR_DECK_ENVIRONMENT_SECRET' \
--header 'Content-Type: application/json' \
--data '{
  "job_code": "EnsureConnection",
  "input": {
    "username": "UserNameExample",
    "password": "PA$$WORDEXAMPLE",
    "source_guid": "e0fb99ac-69d7-452d-aaf4-d15309163011" // Source Guid for our source Aetna
  }
}'
This will return a webhook with your access token.

​
Step 6: Run your other jobs

Execute the jobs you want in Sandbox mode.
Now that you have an access token, we can call FetchPaymentMethods. 
curl --location 'https://sandbox.deck.co/api/v1/jobs/submit' \
--header 'x-deck-client-id: $YOUR_DECK_CLIENT_ID' \
--header 'x-deck-secret: $YOUR_DECK_ENVIRONMENT_SECRET' \
--header 'Content-Type: application/json' \
--data '{
  "job_code": "FetchPaymentMethods",
  "input": {
    "access_token": "<access_token>"  // The access token received from EnsureConnection
  }
}'

​
Step 7: Upgrade your plan

Once you are satisfied with the Jobs you have, upgrade your plan to receive your Production secret and make the calls on Live sources. Remember to change the environment from Sandbox to Production in the upper right area of any job details.

​
Step 8: Go live!

Refer to our Quickstart for all the details about integrating in your app or website.
⌘I