> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Writeback Connectors

Writeback Connectors allow you to push DataSets to third-party file storage applications instead of pulling data from those applications into Domo.

<h4>
  <strong>Next Steps:</strong>
</h4>

You can build your own Writeback Connector in Domo by starting with the [Connector Dev Studio >> Let’s Build](/portal/Connectors/Custom-Connectors/connector-dev-studio#lets-build) section.

You need to complete the following steps when building a custom Writeback Connector:

<ul>
  <li>Create a new Writeback Connector</li>
  <li>Upload Connector icon images</li>
  <li>Configure user authentication</li>
  <li>Configure selectable reports</li>
  <li>Define how the data is processed</li>
</ul>

After you have completed these steps, you can submit the connector for publishing.
Domo developers will review the connector, perform some engineering magic, and notify
you when your connector is available for use.

<div id="Create%20a%20new%20Writeback%20connector" class="doc-row" />

 

### Create a new Writeback Connector

***

<ul>
  <li>
    Click the <strong>Build Now</strong> button at the bottom of the screen to
    create a new connector.
  </li>

  <li>
    <strong>My Connector Developer</strong> page will appear. Here, you will
    need to fill out the <strong>Custom Connector User Agreement</strong>.
  </li>

  <li>
    After accepting the agreement, click on the <strong>Create New</strong> 
    button.
  </li>
</ul>

<img class="alignnone size-full" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/iw1IetDHTR-tXArd/images/dev/web-assets.domo.com/miyagi/images/product/product-feature-dev-portal-dev-rriteback-1.png?fit=max&auto=format&n=iw1IetDHTR-tXArd&q=85&s=2f930d060a2aad967bf08bd73836281f" width="479" height="125" data-path="images/dev/web-assets.domo.com/miyagi/images/product/product-feature-dev-portal-dev-rriteback-1.png" />

<ul>
  <li>
    Click on the <strong>Writeback Connector</strong> tile.
  </li>
</ul>

<img class="alignnone wp-image-3668" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/iw1IetDHTR-tXArd/images/dev/web-assets.domo.com/miyagi/images/product/product-feature-dev-portal-dev-writeback-10.png?fit=max&auto=format&n=iw1IetDHTR-tXArd&q=85&s=556767f4c6b0f22dd0ee42052a7a1022" alt="" width="743" height="452" data-path="images/dev/web-assets.domo.com/miyagi/images/product/product-feature-dev-portal-dev-writeback-10.png" />

<ul>
  <li>
    <strong>Name your connector</strong> screen will appear. Provide a name for
    your Writeback Connector and click <strong>Create</strong> button.
  </li>
</ul>

<img class="alignnone " src="https://mintcdn.com/domoinc-openapi-sync-dataflows/iw1IetDHTR-tXArd/images/dev/web-assets.domo.com/miyagi/images/product/product-feature-dev-portal-dev-rriteback-2.png?fit=max&auto=format&n=iw1IetDHTR-tXArd&q=85&s=1371d2ee110f0edf46c8cb4b012181ea" width="1104" height="229" data-path="images/dev/web-assets.domo.com/miyagi/images/product/product-feature-dev-portal-dev-rriteback-2.png" />

### Upload Connector Icon images

***

<ul>
  <li>
    Once you have created your Writeback Connector, you need to upload the
    Connector icon.
  </li>
</ul>

<img class="alignnone size-full" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/iw1IetDHTR-tXArd/images/dev/web-assets.domo.com/miyagi/images/product/product-feature-dev-portal-dev-rriteback-3.png?fit=max&auto=format&n=iw1IetDHTR-tXArd&q=85&s=9676688ed2358ddbaaf2e10fe3dc3abb" width="548" height="284" data-path="images/dev/web-assets.domo.com/miyagi/images/product/product-feature-dev-portal-dev-rriteback-3.png" />

<ul>
  <li>Select the desired icon image for your connector and click Upload.</li>
</ul>

### Configure Domo authentication

***

You need to configure the Domo authentication after uploading the icon image for your Writeback Connector.

<img class="alignnone size-full" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/iw1IetDHTR-tXArd/images/dev/web-assets.domo.com/miyagi/images/product/product-feature-dev-portal-dev-rriteback-4.png?fit=max&auto=format&n=iw1IetDHTR-tXArd&q=85&s=d533fc28e7950e77acb998e24470a928" width="447" height="231" data-path="images/dev/web-assets.domo.com/miyagi/images/product/product-feature-dev-portal-dev-rriteback-4.png" />

<ul>
  <li>
    Specify your Domo Client Key and Domo Client Secret, and click 
    <strong>Next</strong>.
  </li>
</ul>

### Configure authentication

***

<ul>
  <li>
    Select authentication credentials type as <strong>OAuth 2.0 </strong>and
    write the authentication script.
  </li>
</ul>

<img class="alignnone size-full" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/iw1IetDHTR-tXArd/images/dev/web-assets.domo.com/miyagi/images/product/product-feature-dev-portal-dev-rriteback-5.png?fit=max&auto=format&n=iw1IetDHTR-tXArd&q=85&s=1b84d4a7085e8c26389d904c70e383a4" width="1104" height="491" data-path="images/dev/web-assets.domo.com/miyagi/images/product/product-feature-dev-portal-dev-rriteback-5.png" />

### Define how data is processed

***

<ul>
  <li>Write the data processing script.</li>
</ul>

<img class="alignnone size-full" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/iw1IetDHTR-tXArd/images/dev/web-assets.domo.com/miyagi/images/product/product-feature-dev-portal-dev-rriteback-6.png?fit=max&auto=format&n=iw1IetDHTR-tXArd&q=85&s=de1c81494c8c81e586bcbc599a489979" width="1104" height="637" data-path="images/dev/web-assets.domo.com/miyagi/images/product/product-feature-dev-portal-dev-rriteback-6.png" />

### Submit for publishing

***

After you have written and tested your connector, you are ready for publishing! You can choose to make the connector only available to your private company or available to any Domo user. Follow the guide below to submit the connector for approval. Once approved, your connector is ready to go!

<ul>
  <li>
    Click <strong>Submit for Publishing</strong>.
  </li>
</ul>

<img class="alignnone size-full wp-image-3669" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/iw1IetDHTR-tXArd/images/dev/web-assets.domo.com/miyagi/images/product/product-feature-dev-portal-dev-writeback-11.png?fit=max&auto=format&n=iw1IetDHTR-tXArd&q=85&s=ddcdefcd93296dca0f2d6a9b7a1ea62f" alt="" width="1104" height="292" data-path="images/dev/web-assets.domo.com/miyagi/images/product/product-feature-dev-portal-dev-writeback-11.png" />

### Writeback methods

***

<strong id="listDatasets">DOMO.listDatasets();</strong>{' '}

> Returns:\
> a list of all DOMO dataset IDs

<strong id="getDataset(datasetId)">DOMO.getDataset(datasetId);</strong>>
datasetId = ID of dataset within DOMO that you’d like to pull data from.
Example: `id = metadata.parameters.datasetId;`

> Returns:\
> a full dataset object

<strong id="queryData(datasetId, query)">
  DOMO.queryData(datasetId, query);
</strong>

> datasetId = ID of dataset within DOMO that you’d like to pull data from.
> query = the sql command you’d like to perform on returned data
> Example:

```
query = "select * from tbl where action = 'open'";
```

Best practices:

* let id = metadata.parameters.datasetId;
* let query = "select \* from tbl where action = 'open'";
* let data = DOMO.getDataset(id).queryData(query);

### Where can I find the DataSet ID?

***

You can find the DataSet ID in the URL of the dataset as shown below.

<img class="alignnone size-full" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/iw1IetDHTR-tXArd/images/dev/web-assets.domo.com/miyagi/images/product/product-feature-dev-portal-dev-rriteback-8.png?fit=max&auto=format&n=iw1IetDHTR-tXArd&q=85&s=6d1350115ab31c4aefa7cf41a4d9b020" width="597" height="286" data-path="images/dev/web-assets.domo.com/miyagi/images/product/product-feature-dev-portal-dev-rriteback-8.png" />

### How can I access the DataSet ID?

***

<ul>
  <li>
    Add a parameter named datasetId. Provide the attributes to it, like help
    text to be displayed for it.
  </li>

  <li>
    Click <strong>Add Parameter</strong>.
  </li>
</ul>

<img class="alignnone size-full" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/iw1IetDHTR-tXArd/images/dev/web-assets.domo.com/miyagi/images/product/product-feature-dev-portal-dev-rriteback-9.png?fit=max&auto=format&n=iw1IetDHTR-tXArd&q=85&s=c7287f8fdcafc1918ac71a0c0e810463" width="1579" height="332" data-path="images/dev/web-assets.domo.com/miyagi/images/product/product-feature-dev-portal-dev-rriteback-9.png" />
