https://embedded-workflow-builder.netlify.app/assets/js/4e42a435.f8535bd6.js

1"use strict";(self.webpackChunkembedded_workflow_builder_docs=self.webpackChunkembedded_workflow_builder_docs||[]).push([["6868"],{1028(e,n,s){s.r(n),s.d(n,{metadata:()=>t,default:()=>l,frontMatter:()=>i,contentTitle:()=>o,toc:()=>h,assets:()=>c});var t=JSON.parse('{"id":"connectors/amqp","title":"AMQP Connector","description":"Send and receive messages on an AMQP-based message broker","source":"@site/docs/connectors/amqp.md","sourceDirName":"connectors","slug":"/connectors/amqp","permalink":"/connectors/amqp","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"title":"AMQP Connector","sidebar_label":"AMQP","description":"Send and receive messages on an AMQP-based message broker"},"sidebar":"docs","previous":{"title":"Amazon SQS","permalink":"/connectors/aws-sqs"},"next":{"title":"Anthropic","permalink":"/connectors/anthropic"}}'),r=s(74848),d=s(28453);let i={title:"AMQP Connector",sidebar_label:"AMQP",description:"Send and receive messages on an AMQP-based message broker"},o,c={},h=[{value:"API Documentation",id:"api-documentation",level:2},{value:"Connections",id:"connections",level:2},{value:"AMQP Connection",id:"amqp",level:3},{value:"Actions",id:"actions",level:2},{value:"Acknowledge Message",id:"acknowledgemessage",level:3},{value:"Check AMQP Connection",id:"checkconnection",level:3},{value:"Get Message",id:"getmessage",level:3},{value:"Publish Message",id:"publishmessage",level:3},{value:"Reject Message",id:"rejectmessage",level:3}];function a(e){let n={a:"a",code:"code",h2:"h2",h3:"h3",img:"img",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,d.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.img,{alt:"AMQP",src:s(29852).A+"#connector-icon",width:"32",height:"32"}),"\nThe Advanced Message Queuing Protocol (",(0,r.jsx)(n.strong,{children:"AMQP"}),") is a standard protocol for interacting with message brokers and queueing platforms.\nIt is used by many common message broker services like ",(0,r.jsx)(n.a,{href:"https://azure.microsoft.com/en-us/services/event-hubs/",children:"Azure Event Hubs"}),", ",(0,r.jsx)(n.a,{href:"https://qpid.apache.org/",children:"Apache Qpid"}),", ",(0,r.jsx)(n.a,{href:"https://www.rabbitmq.com/",children:"RabbitMQ"})," and more."]}),"\n",(0,r.jsx)(n.p,{children:"This component allows you to manage messages on an AMQP-based queue."}),"\n",(0,r.jsx)(n.h2,{id:"api-documentation",children:"API Documentation"}),"\n",(0,r.jsxs)(n.p,{children:["This component was built using the ",(0,r.jsx)(n.a,{href:"https://amqp-node.github.io/amqplib/channel_api.html#api_reference",children:"AMQP API Reference"}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"connections",children:"Connections"}),"\n",(0,r.jsx)(n.h3,{id:"amqp",children:"AMQP Connection"}),"\n",(0,r.jsx)(n.p,{children:"Authenticate requests to an amqp server"}),"\n",(0,r.jsxs)(n.p,{children:["An AMQP connection is comprised of a host name (this can be an IP address or FQDN endpoint), port, protocol and vhost.\nFor example, if you are told that your AMQP server is hosted at ",(0,r.jsx)(n.code,{children:"amqps://amqp.example.com:5672/example/vhost"}),", enter ",(0,r.jsx)(n.code,{children:"amqp.example.com"})," for the ",(0,r.jsx)(n.strong,{children:"host"}),", and ",(0,r.jsx)(n.code,{children:"5672"})," for the ",(0,r.jsx)(n.strong,{children:"port"}),", select ",(0,r.jsx)(n.code,{children:"AMQPS"})," for the ",(0,r.jsx)(n.strong,{children:"protocol"}),", and enter ",(0,r.jsx)(n.code,{children:"example/vhost"})," for the ",(0,r.jsx)(n.strong,{children:"vhost"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["AMQP often requires authentication (a username and password), but some AMQP servers are anonymous and do not require authentication.\nIf the server you're interacting with is allows anonymous authentication, you can omit the ",(0,r.jsx)(n.strong,{children:"username"})," and ",(0,r.jsx)(n.strong,{children:"password"})," fields."]}),"\n",(0,r.jsxs)(n.p,{children:["You can verify that your settings are correct using the this component's ",(0,r.jsx)(n.a,{href:"#checkconnection",children:"Check AMQP Connection"})," action."]}),"\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\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:"Host"}),(0,r.jsx)(n.td,{children:"The IP address or endpoint of the AMQP server"}),(0,r.jsx)(n.td,{children:"192.168.0.1"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Port"}),(0,r.jsx)(n.td,{children:"The port of the AMQP server"}),(0,r.jsx)(n.td,{children:"5672"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Protocol"}),(0,r.jsx)(n.td,{children:"Provide the desired protocol in which you want to interact with the queue."}),(0,r.jsx)(n.td,{children:"amqp"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Vhost"}),(0,r.jsx)(n.td,{children:'The "example/vhost" portion of amqps://amqp.example.com:5672/example/vhost'}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Username"}),(0,r.jsx)(n.td,{children:"This can be omitted if the AMQP server allows anonymous authentication"}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Password"}),(0,r.jsx)(n.td,{children:"This can be omitted if the AMQP server allows anonymous authentication"}),(0,r.jsx)(n.td,{})]})]})]}),"\n",(0,r.jsx)(n.h2,{id:"actions",children:"Actions"}),"\n",(0,r.jsx)(n.h3,{id:"acknowledgemessage",children:"Acknowledge Message"}),"\n",(0,r.jsx)(n.p,{children:"Acknowledge a previously fetched message"}),"\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:"Message"}),(0,r.jsx)(n.td,{children:"An AMQP message. This must reference the results of a previous 'Get Message' step"}),(0,r.jsx)(n.td,{})]})]})]}),"\n",(0,r.jsx)(n.h3,{id:"checkconnection",children:"Check AMQP Connection"}),"\n",(0,r.jsx)(n.p,{children:"Verify that an AMQP server is available, and return the server's connection information. This is helpful for debugging purposes."}),"\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:"getmessage",children:"Get Message"}),"\n",(0,r.jsx)(n.p,{children:"Receives a message from an AMQP-based queue"}),"\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:"Queue Name"}),(0,r.jsx)(n.td,{children:"Provide the name of the queue you would like to interact with."}),(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:"Acknowledge Message"}),(0,r.jsx)(n.td,{children:'Automatically mark the message received as "Acknowledged"'}),(0,r.jsx)(n.td,{children:"true"})]})]})]}),"\n",(0,r.jsx)(n.h3,{id:"publishmessage",children:"Publish Message"}),"\n",(0,r.jsx)(n.p,{children:"Add a message to an AMQP-based queue"}),"\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\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:"Queue Name"}),(0,r.jsx)(n.td,{children:"Provide the name of the queue you would like to interact with. (Note: this input is required when Route Messages is false.)"}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Exchange"}),(0,r.jsx)(n.td,{children:"Provide the name of the exchange you would like to interact with. (Note: this parameter is required when Route Messages is true.)"}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Routing Key"}),(0,r.jsx)(n.td,{children:"Provide the routing key you would like to use. (Note: this parameter is required when Route Messages is true.)"}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Route Message"}),(0,r.jsx)(n.td,{children:"If you would like to route this message, check this box."}),(0,r.jsx)(n.td,{children:"false"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Message"}),(0,r.jsx)(n.td,{children:"Provide a message to push on to the queue."}),(0,r.jsx)(n.td,{})]})]})]}),"\n",(0,r.jsx)(n.h3,{id:"rejectmessage",children:"Reject Message"}),"\n",(0,r.jsx)(n.p,{children:"Rejects one message from an AMQP-based queue"}),"\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:"Queue Name"}),(0,r.jsx)(n.td,{children:"Provide the name of the queue you would like to interact with."}),(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 l(e={}){let{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},29852(e,n,s){s.d(n,{A:()=>t});let t="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAACXBIWXMAAAsSAAALEgHS3X78AAAFEklEQVRYhcWXa2xTZRjHn55Lz9aixpkwwI1dpOtgKIoy4AMMwaAs+8AlfjKB+WUf1OhXNMYY22JgDOVipiCXLRFC2bqxjbkbCyZC791Y1/u6ld26bgMRqel22j7mPbQTh5Lu6pv88uSc/s/z/s/z9LznPQD/9ygqKlpvsljK/IExhdvdq+r19Qt4++4ofP2Dx0ZHRwuIru7G4OY2beBYuyGguK4PqKbQBZTtxtFSvWcij+hcrp7CXl9/Gbk+nivOwNCQIhgMphEdIoriHt7fvWcv9vT6eJfHiza7Cx0uD9qdbj4wdhdHRsY/IyJ1y8AnTbo/sarVz1e3+TFOVetwuEn3EH+1hvYRXYfVfmLQHyA5eJInRtTudJM5IpOTuDFmgBJmZ1l2Pznevn1HyGjuCBO0emNYZzCFnO4edHv7DhJd5VXXR+qmQazUOEMVNc7wFNWOyStNA9isH99DdDqDpcxqd6LeaA7pjeYwwWCy8Fq9MdJx2zoRDAY3/MMAABTTNI0AwBdse5NciOaO26jVG3mPtw893r5PBQO1jo/JHVfWuPjKWhfGqdA4ItVtw9hiGN9LdFqj+Rty12RSg8mCMaIkb2eXNXz/fjD/CQMAgDRN8yRuLdiGepMZTZZOoSUe750FN3CAHAPAJE3TUQCIbtmyNarVmyZ7ff3odHsPLkoFAECoQKwdmJ+/kXe6PegPjC9aBSYAIEKgaZrEiV2FRXhTaxIqcL7atmAGngeAdQBAnuO1cViWzZNIJOsKC99dRkRnr9g/rGpdGANPHWpEWojN3g9qro/gBY1zng28dPRtyD1ugNyTrZB7on06ojUn2yH726acd845z1Y58GK9O3pe45xHA/IjxbD6FEJOKQ/yUvw3RKuPImQoMeetcjx92YYXGzx4XuOYJwMy5X6QH0WQqUIgU4X/C0p+KAJpX2LOjnI8o7bhpQYPXtA4sKJm7gaKQV6GsErFg0yFT4OSH8K4idOXu4VKnKuyL54BeMxE9rbv8PtLVvyp3hVRNw9hi+G32RpQHBB

1asEo1ATJVJBEeteOLSFbBqUj5xS6+7oYf62+N7Jmlga+LIfc4guwwDzmHMVGo3FKElUrM2FoeqagfRLMrFKuAZaaP4Ve7QabsB5miC2QK20yg5EobLPvcunbXmd4fNe6dJN1N/TwvRIkOtVotLFh6o+WIzeGakQEpAGQAQPpsSUqC9NTU1CwAeKGt/Zcf3D19qNUZwokaeC/2MvodAB7OFpFI9AcAPMjMyppobGrB21Y73tIZZv46hjkgEomEmJWdjY0/N2NX95SJxDYkABCdKxRFkYiZmZlYf60Ru7odxMTiVABiUBQlxPT0dKxraESrzRG9qdVjZ1f34hiAx0ysXJmBV+saoqQdJktn+H4wgR0R/M1c2hGhKGFnFVmxYkW4uqY26vH2TQ6PjT2xLS+JGQjPZwWmVSK6fPlyrKu/Frl374HwpVVSUsIKs4tE7CmKSXJTTJKTYpK8FMP5KIYboBhumGI4P8VwAYrhRimGG6cY7i7FcPemcTfGeExH9CMUww0JeWjOx4glPQDgzJHnWTdt2qwEgH1isXg1AJDFS5oqlaYuTU5OSeO45zI57tlVYvGSXJaV5rGs9BWWlbzKspL1LCt5nWGS32CY5PxpbCDnye8sK3ntkV76sli8ZI1Y/Iyc5CN5U1LSXpRKpUsBIBUAUgAgKeFldqEH+Up9HPLnmG+mzzH1ZfwXlKnCCy2kp3oAAAAASUVORK5CYII="},28453(e,n,s){s.d(n,{R:()=>i,x:()=>o});var t=s(96540);let r={},d=t.createContext(r);function i(e){let n=t.useContext(d);return t.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(d.Provider,{value:n},e.children)}}}]);