https://embedded-workflow-builder.netlify.app/assets/js/3f2990cd.14f5de5f.js

1"use strict";(self.webpackChunkembedded_workflow_builder_docs=self.webpackChunkembedded_workflow_builder_docs||[]).push([["1414"],{38450(e,n,t){t.r(n),t.d(n,{metadata:()=>i,default:()=>h,frontMatter:()=>d,contentTitle:()=>l,toc:()=>c,assets:()=>o});var i=JSON.parse('{"id":"connectors/firebase","title":"Firebase Connector","description":"Create, read, update, and delete documents in a Firebase Cloud Firestore database collection.","source":"@site/docs/connectors/firebase.md","sourceDirName":"connectors","slug":"/connectors/firebase","permalink":"/connectors/firebase","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"title":"Firebase Connector","sidebar_label":"Firebase","description":"Create, read, update, and delete documents in a Firebase Cloud Firestore database collection."},"sidebar":"docs","previous":{"title":"Expensify","permalink":"/connectors/expensify"},"next":{"title":"First Resonance ION","permalink":"/connectors/first-resonance"}}'),r=t(74848),s=t(28453);let d={title:"Firebase Connector",sidebar_label:"Firebase",description:"Create, read, update, and delete documents in a Firebase Cloud Firestore database collection."},l,o={},c=[{value:"Connections",id:"connections",level:2},{value:"Private Key",id:"firebaseconnection",level:3},{value:"Actions",id:"actions",level:2},{value:"Bulk Create Documents",id:"bulkcreatedocuments",level:3},{value:"Create Document",id:"createdocument",level:3},{value:"Delete Document",id:"deletedocument",level:3},{value:"Get Document",id:"getdocument",level:3},{value:"List Collections",id:"listcollections",level:3},{value:"List Documents",id:"listdocuments",level:3},{value:"Remove Field",id:"removefield",level:3},{value:"Update Document",id:"updatedocument",level:3}];function a(e){let n={a:"a",br:"br",code:"code",h2:"h2",h3:"h3",img:"img",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.img,{alt:"Firebase",src:t(15994).A+"#connector-icon",width:"32",height:"32"}),"\n",(0,r.jsx)(n.a,{href:"https://firebase.google.com",children:"Firebase"})," is a platform developed by Google for creating mobile and web applications.\nFirebase Cloud Firestore is a document-based, flexible, scalable, and NoSQL cloud database, used to store and sync data for client and server-side applications.\nThis component uses the Firebase Admin SDK to create, read, update, delete, and list documents within a Firebase Cloud Firestore collection.\nSee more information in the Cloud Firestore section of the Firebase Admin SDK in the ",(0,r.jsx)(n.a,{href:"https://firebase.google.com/docs/reference/admin",children:"Firebase Docs"}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"connections",children:"Connections"}),"\n",(0,r.jsx)(n.h3,{id:"firebaseconnection",children:"Private Key"}),"\n",(0,r.jsx)(n.p,{children:"Authenticate requests to Firebase using values obtained from the Google Cloud Platform."}),"\n",(0,r.jsxs)(n.p,{children:["The Firebase Admin SDK is a set of server libraries that lets you interact with Firebase from privileged environments.\nTo authenticate through the Firebase Admin SDK, follow the instructions to generate a private key located on the Firebase ",(0,r.jsx)(n.a,{href:"https://firebase.google.com/docs/admin/setup#set-up-project-and-service-account",children:"docs"}),"\nThis will involve you creating a service account in the Google Cloud Platform and generating credentials for that user.\nYou will receive a JSON file containing many fields including a private key, and client email which you will use to make a new connection.\nIn the new connection, enter the value of the client email, private key, and your GCP project Id."]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Input"}),(0,r.jsx)(n.th,{children:"Comments"}),(0,r.jsx)(n.th,{children:"Default"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Project Id"}),(0,r.jsx)(n.td,{children:"Provide the unique identifier of the project from the Google Cloud Platform."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Private Key"}),(0,r.jsx)(n.td,{children:"Provide the private key from the Google Cloud Platform."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Email"}),(0,r.jsx)(n.td,{children:"Provide the client email for the GCP account."}),(0,r.jsx)(n.td,{})]})]})]}),"\n",(0,r.jsx)(n.h2,{id:"actions",children:"Actions"}),"\n",(0,r.jsx)(n.h3,{id:"bulkcreatedocuments",children:"Bulk Create Documents"}),"\n",(0,r.jsx)(n.p,{children:"Create multiple documents in a Cloud Firestore collection in a single operation"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Input"}),(0,r.jsx)(n.th,{children:"Comments"}),(0,r.jsx)(n.th,{children:"Default"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Connection"}),(0,r.jsx)(n.td,{}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Collection"}),(0,r.jsx)(n.td,{children:"Provide a string value for the collection name."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Documents"}),(0,r.jsx)(n.td,{children:"An array of documents to be created in the collection."}),(0,r.jsx)(n.td,{children:(0,r.jsxs)(n.code,{children:["[",(0,r.jsx)(n.br,{})," {",(0,r.jsx)(n.br,{}),' "field1": "value1",',(0,r.jsx)(n.br,{}),' "field2": "value2"',(0,r.jsx)(n.br,{})," },",(0,r.jsx)(n.br,{})," {",(0,r.jsx)(n.br,{}),' "field1": "value3",',(0,r.jsx)(n.br,{}),' "field2": "value4"',(0,r.jsx)(n.br,{})," }",(0,r.jsx)(n.br,{}),"]"]})})]})]})]}),"\n",(0,r.jsx)(n.h3,{id:"createdocument",children:"Create Document"}),"\n",(0,r.jsx)(n.p,{children:"Create a document in a Cloud Firestore collection"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Input"}),(0,r.jsx)(n.th,{children:"Comments"}),(0,r.jsx)(n.th,{children:"Default"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Collection"}),(0,r.jsx)(n.td,{children:"Provide a string value for the collection name."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Data"}),(0,r.jsx)(n.td,{children:"Provide a key value pair that represents your data."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Connection"}),(0,r.jsx)(n.td,{}),(0,r.jsx)(n.td,{})]})]})]}),"\n",(0,r.jsx)(n.h3,{id:"deletedocument",children:"Delete Document"}),"\n",(0,r.jsx)(n.p,{children:"Remove a document from a Cloud Firestore collection"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Input"}),(0,r.jsx)(n.th,{children:"Comments"}),(0,r.jsx)(n.th,{children:"Default"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Collection"}),(0,r.jsx)(n.td,{children:"Provide a string value for the collection name."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Document"}),(0,r.jsx)(n.td,{children:"Provide a string value for the unique identifier of the document."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Connection"}),(0,r.jsx)(n.td,{}),(0,r.jsx)(n.td,{})]})]})]}),"\n",(0,r.jsx)(n.h3,{id:"getdocument",children:"Get Document"}),"\n",(0,r.jsx)(n.p,{children:"Get the contents of a document in a Cloud Firestore collection"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Input"}),(0,r.jsx)(n.th,{children:"Comments"}),(0,r.jsx)(n.th,{children:"Default"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Collection"}),(0,r.jsx)(n.td,{children:"Provide a string value for the collection name."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Document"}),(0,r.jsx)(n.td,{children:"Provide a string value for the unique identifier of the document."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Connection"}),(0,r.jsx)(n.td,{}),(0,r.jsx)(n.td,{})]})]})]}),"\n",(0,r.jsx)(n.h3,{id:"listcollections",children:"List Collections"}),"\n",(0,r.jsx)(n.p,{children:"List all collections in a Cloud Firestore database"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Input"}),(0,r.jsx)(n.th,{children:"Comments"}),(0,r.jsx)(n.th,{children:"Default"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Connection"}),(0,r.jsx)(n.td,{}),(0,r.jsx)(n.td,{})]})})]}),"\n",(0,r.jsx)(n.h3,{id:"listdocuments",children:"List Documents"}),"\n",(0,r.jsx)(n.p,{children:"List all documents in a Cloud Firestore collection"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Input"}),(0,r.jsx)(n.th,{children:"Comments"}),(0,r.jsx)(n.th,{children:"Default"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Collection"}),(0,r.jsx)(n.td,{children:"Provide a string value for the collection name."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Connection"}),(0,r.jsx)(n.td,{}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Order By"}),(0,r.jsx)(n.td,{children:"Provide a string value for the field to order by."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Query Operators"}),(0,r.jsx)(n.td,{}),(0,r.jsx)(n.td,{})]})]})]}),"\n",(0,r.jsx)(n.h3,{id:"removefield",children:"Remove Field"}),"\n",(0,r.jsx)(n.p,{children:"Completely removes a field from a given document (may not work on a field with a null value)"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Input"}),(0,r.jsx)(n.th,{children:"Comments"}),(0,r.jsx)(n.th,{children:"Default"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Collection"}),(0,r.jsx)(n.td,{children:"Provide a string value for the collection name."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Document"}),(0,r.jsx)(n.td,{children:"Provide a string value for the unique identifier of the document."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Field To Remove"}),(0,r.jsx)(n.td,{children:"Provide a string value for the name of the field you would like to remove from the document."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Connection"}),(0,r.jsx)(n.td,{}),(0,r.jsx)(n.td,{})]})]})]}),"\n",(0,r.jsx)(n.h3,{id:"updatedocument",children:"Update Document"}),"\n",(0,r.jsx)(n.p,{children:"Update a document in a Cloud Firestore collection"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Input"}),(0,r.jsx)(n.th,{children:"Comments"}),(0,r.jsx)(n.th,{children:"Default"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Collection"}),(0,r.jsx)(n.td,{children:"Provide a string value for the collection name."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Document"}),(0,r.jsx)(n.td,{children:"Provide a string value for the unique identifier of the document."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Data"}),(0,r.jsx)(n.td,{children:"Provide a key value pair that represents your data."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Connection"}),(0,r.jsx)(n.td,{}),(0,r.jsx)(n.td,{})]})]})]})]})}function h(e={}){let{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},15994(e,n,t){t.d(n,{A:()=>i});let i="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAACXBIWXMAABcRAAAXEQHKJvM/AAAFJElEQVRYhcWXXWxTZRzGy5iJBNy6ne57gIgCun6vW4c3kHDhnYkJuzB6zaXeeGNiKEQgDkMCQVESEeRjbU8pDAkXBnXyFdh6SrcJCBpDYgxINBLFdh/nvO/PnI+ODiZ0Q/RNmtO0Pe/ze/7P+3/7HperzAGuOa

17/awAVxGIVuP5jCGKuCuuaenYb6SUbSz97/OIu2y0wh77mLEcaxzjse2YKGK45jy0anIk52V5NsukGJxoh3brL+c6K4/ECxByXR5f7SDZMkKxHphoKpJeGJyH6Y5Vo656Y3kCswqze7AFU11zrml78CukGiNfpHKuDdEti8jeJlj2oLXtLgSfhHnXB0u+qtK6p5rc43mgDxD1wuB76novSt3w5KUXIVK2BuqSzCIHabYMPdS/hYnedAzRn9hVINn/McacCvR5Bn4JINR0T6eZDpGsg7YaUJ2X9Vmu34mD4pTDZ6DjZ6GbbzKrKmYm77hKjNp2krx4Z9xjEFWRcQf/EI8ReRRB3S3rdkKyRHF20xoZYHWUk+jPXIwgtpM6qAhQ7oH/xkzLZeJ3DdRD3CBPAOOgh31MrR7e6pex1Iw9VGxytht7qPoZeDjESvclwGIZCyGw4V3Q/IwiKHRBf/DSJulGSHuhVpAkw9pFCYVMNhXdr0HdXQ7Ia9s/HSDePy+HobVNcZoIGuRBSC91GW+WZOYDq5J9atIak5R7iijQOeChsrXUA3Iy+70Z+Nh9DbUYMdkhyYclgSKIFIRsELSjIdNkLlBnsoBQ7QG1aZ+Xfqxhm9mO7HPeb3BS2uMmvX8DYnhak1gnZdsiY4iFTGDIBwaUQMhd+zQawu6PcCCqta6JxK8frTfe6vl+h0FNrObfEYwvIb29BXOiEnCkeZlLcegV0fggjMqENM+4Eiosw0XCEPg+iVzHGPlSs3AtbashvWEB+hyM+VBSfBuBqyFwPB2cUAcU/of5VlTJRN0xaYWKfIgrv1VLYbIo/ZYsPRGEoAlr7NOJOBN9a7wfMbbnUWHnuP1/mkQnPbVSF0Z21srC51hFvRVwoETezt8SnuIeMX5Lzg+b7ldwqd/kAMacFE60dJBSh71XI9yhyevHpSl8CoPlA8+pcDAbKjoFiC/Y2vcphD6M7FZFfX0Vhx0LEQBcMddx1Pi1AwAHwwaBPMuyHi8G1ZXcCky1Y/465A/61sUq3nRfFI5CNPMy9DZDx6lwzgfxvl90JOBHoiYZ97Kohv32hLi3nnSXixYUXvl+86N56telctWA+LSsCSv6ERj+oOc3uRRgXuoTtvMMRL9e9GUGb4JJViVPTadwP4KxSeaC2Sj+w9BZ25oYt3jFD917kYJtBtg057L31u9ZeXarxQIDfdnRW6We6Mvy4EkY6hdQiBlpEThV/gPtBr8QUH/JKvvNjnH1BM8+WDwWYshGprfPGvom8aQxEfuH7KAxHhNTCxj+798OgHznoNch5hZm9cb7txtjXz7/xk9o6r3TusgYO6c0vVtaPn4lsE9lInmtmDGFBJijuLb3M+Aw0n+BqADHovTN+akXPn2rwEY5kmEfu7rnFm8f621cYZ4KqyIUFV8z9PyCkFjCk5jfI+AVXgoisz5g41XbojxMrlk03x6wG5gkX1+Qkd04GVhtnA+e4HIbLYcnlkGQkwMRpb3/hq7YX7wpb9/x7T1EQq1CdE6/a7Zo73h94XT/ny+hn/efzX/rW3l07/7Kw614Q1Syp/cBhAqndzjHcfHh1AB/7sB/L7GyL5Z7tXH8DbW0jg6LUBtEAAAAASUVORK5CYII="},28453(e,n,t){t.d(n,{R:()=>d,x:()=>l});var i=t(96540);let r={},s=i.createContext(r);function d(e){let n=i.useContext(s);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:d(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]);