QuickBooks Online Events

Cloud Elements supports events via polling or webhooks depending on the API provider. For more information about our Events framework, see Events Overview.

Supported Events and Resources

Cloud Elements supports polling events and webhooks for QuickBooks Online. After receiving an event, Cloud Elements standardizes the payload and sends an event to the configured callback URL of your authenticated element instance.

Polling

You can set up polling for the events resource. You can also copy the events configuration to poll other resources. See Configure Polling Through API for more information.

You can set up events for the following resources:

• bill-payments
• bills
• classes
• credit-memos
• credit-terms
• currencies
• customers
• employees
• invoices
• journal-entries
• ledger-accounts
• payment-methods
• payments
• products
• purchase-orders
• refund-receipts
• sales-receipts
• tax-codes
• tax-rates
• time-activities
• vendor-credits
• vendors

Configure Polling Through the UI

To configure polling through the UI, follow the same steps to authenticate an element instance, and then turn on events. Select the resources to poll, and then click Create Instance. For more information, see Authenticate an Element Instance with Events (UI) or the element-specific authentication topic.

After successfully authenticating, we give you several options for next steps. Make requests using the API docs associated with the instance, map the instance to a virtual data resource, or use it in a formula template.

Configure Polling Through API

Use the /instances endpoint to authenticate with QuickBooks Online and create an element instance with polling enabled.

To authenticate an element instance with polling:

1. Complete the authentication steps for the authentication up to constructing the final authentication JSON body.

2. Construct a JSON body as shown below (see Parameters):

      {
        "element":{
          "key":"quickbooks"
        },
        "providerData":{
          "code": "<AUTHORIZATION_GRANT_CODE>",
          "realmId": "<REALMID_FROM_PREVIOUS_STEP>"
        },
        "configuration":{
          "oauth.callback.url": "<CALLBACK_URL>",
          "oauth.api.key": "<CONSUMER_KEY>",
           "oauth.api.secret": "<CONSUMER_SECRET>",
          "authentication.type" : "oauth2",
          "scope" : "com.intuit.quickbooks.accounting openid profile email phone address",
          "event.notification.enabled": true,
          "event.vendor.type": "polling",
          "event.notification.callback.url": "https://api.cloud-elements.com/elements/api-v2/events/quickbooks/",
          "event.notification.signature.key": "<OPTIONAL_SIGNATURE_KEY>",
           "event.poller.refresh_interval": "15",
          "event.poller.urls": "bill-paymentsbillsclassescredit-memoscredit-termscurrenciescustomersemployeesinvoicesjournal-entriesledger-accountspayment-methodspaymentsproductspurchase-ordersrefund-receiptssales-receiptstax-codestax-ratestime-activitiesvendor-creditsvendors"
        },
        "tags":[
          "<Add_Your_Tag>"
        ],
        "name":"<INSTANCE_NAME>"
      }
   }
   

   
   

3. Call the following, including the JSON body you constructed in the previous step:

   POST /instances
   

   Note: Make sure that you include the User and Organization keys in the header. For more information, see Authorization Headers, Organization Secret, and User Secret.

4. Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL with Polling

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "quickbooks"
  },
  "providerData": {
    "code": "xxxxxxxxxxxxxxxxxxxxxxx",
    "realmId": "xxxxxxxxxxxxxxxxx"
  },
  "configuration": {
    "oauth.callback.url": "https;//mycoolapp.com",
    "oauth.api.key": "xxxxxxxxxxxxxxxxxx",
    "oauth.api.secret": "xxxxxxxxxxxxxxxxxxxxxxxx"
    "authentication.type" : "oauth2",
    "scope" : "com.intuit.quickbooks.accounting openid profile email phone address",
    "event.notification.enabled": true,
    "event.vendor.type": "polling",
    "event.notification.callback.url": "https://api.cloud-elements.com/elements/api-v2/events/quickbooks/",
    "event.notification.signature.key": "xxxxxxxxxxxxxxxxxxxxxx",
    "event.poller.refresh_interval": "15",
    "event.poller.urls": "bill-paymentsbillsclassescredit-memoscredit-termscurrenciescustomersemployeesinvoicesjournal-entriesledger-accountspayment-methodspaymentsproductspurchase-ordersrefund-receiptssales-receiptstax-codestax-ratestime-activitiesvendor-creditsvendors"
    },
  "tags": [
    "Docs"
  ],
  "name": "API Instance"
}'

Polling Parameters

API parameters not shown in Cloud Elements are in code formatting.

Webhooks

You can configure webhooks through the UI or in the JSON body of the /instances API request .

Configure Webhooks Through the UI

To configure webhooks through the UI, follow the same steps to authenticate an element instance, and then turn on events. For more information, see Authenticate an Element Instance with Events (UI) or the element-specific authentication topic.

Configure Webhooks Through API

Use the /instances endpoint to authenticate with and create an element instance with webhooks enabled.

To authenticate an element instance with webhooks:

1. Get an authorization grant code by completing the steps in Getting a redirect URL and Authenticating users and receiving the authorization grant code.

2. Construct a JSON body as shown below (see Parameters):

      {
        "element":{
          "key":"quickbooks"
        },
        "providerData":{
          "code": "<AUTHORIZATION_GRANT_CODE>",
          "realmId": "<REALMID_FROM_PREVIOUS_STEP>"
        },
        "configuration":{
          "oauth.callback.url": "<CALLBACK_URL>",
          "oauth.api.key": "<CONSUMER_KEY>",
           "oauth.api.secret": "<CONSUMER_SECRET>",
          "authentication.type" : "oauth2",
          "scope" : "com.intuit.quickbooks.accounting openid profile email phone address",
          "event.notification.enabled": true,
          "event.vendor.type": "webhooks",
          "event.notification.callback.url": "https://api.cloud-elements.com/elements/api-v2/events/quickbooks/",
          "event.notification.signature.key": "<OPTIONAL_SIGNATURE_KEY>"
         },
        "tags":[
          "<Add_Your_Tag>"
        ],
        "name":"<INSTANCE_NAME>"
      }
   

   
   

3. Call the following, including the JSON body you constructed in the previous step:

   POST /instances
   

   Note: Make sure that you include the User and Organization keys in the header. See the Overview for details.

4. Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL with Polling

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "quickbooks"
  },
  "providerData": {
    "code": "xxxxxxxxxxxxxxxxxxxxxxx",
    "realmId": "xxxxxxxxxxxxxxxxx"
  },
  "configuration": {
    "oauth.callback.url": "https;//mycoolapp.com",
    "oauth.api.key": "xxxxxxxxxxxxxxxxxx",
    "oauth.api.secret": "xxxxxxxxxxxxxxxxxxxxxxxx"
    "authentication.type" : "oauth2",
    "scope" : "com.intuit.quickbooks.accounting openid profile email phone address",
    "event.notification.enabled": true,
    "event.vendor.type": "webhook",
    "event.notification.callback.url": "https://api.cloud-elements.com/elements/api-v2/events/quickbooks/",
    "event.notification.signature.key": "xxxxxxxxxxxxxxxxxxxxxx"
    },
  "tags": [
    "Docs"
  ],
  "name": "API Instance"
}'

Webhook Parameters

API parameters not shown in the Cloud Elements are in code formatting.