​
The Endpoint

The main endpoint used to submit Jobs is: 
/api/v1/jobs/submit
This endpoint lets you submit a task - referred to as a Job - via Deck’s API.
When you call it, the results are returned via Webhooks. You can use those results to trigger additional Jobs, creating a dynamic flow that communicates with various platforms to complete your workflows. To use the API, you must specify a Job Code.
For example:
  • Use "EnsureConnection" to initiate a connection to a platform
  • Use "MakePayment" to trigger a payment
Here’s an example call: 
curl --location 'https://live.deck.co/api/v1/jobs/submit' \
--header 'x-deck-client-id: f6ae3546-3729-47a4-55f3-08dd0r9defea' \
--header 'x-deck-secret: fe007096-63bd-4566-cb19-08dd8d9df017' \
--header 'Content-Type: application/json' \
--data '{
  "job_code": "MakePayment",
  "input": {
    "access_token": "access-production-b7dbff48-ed10-4eeb-4789-08dd6b7k00m8",
    "account_id": "123456789",
    "amount": 10.00,
    "payment_method_id": "pm-0001"
  }
}'
All supported Job Codes and examples are available within the Links you create on the Links page of your Dashboard. The input parameters vary by Job.
For example, making a payment requires:
  • The Access token from your connection webhook
  • The account ID from which to withdraw funds
  • The amount to be paid
  • The payment method ID
Once you’ve provided all required inputs, the endpoint handles the rest.

​
Sample Webhook Response

Here’s an example webhook response from a FetchBalance Job: 
{
  "job_guid": "b35aa2af-41e4-4833-95c9-9efd2069e70c",
  "output": {
    "balance": 34.50
  },
  "webhook_type": "Job",
  "webhook_code": "FetchBalance",
  "environment": "Production"
}