Bindings overview

Overview of the bindings API building block

Using Dapr’s bindings API, you can trigger your app with events coming in from external systems and interface with external systems. With the bindings API, you can:

• Avoid the complexities of connecting to and polling from messaging systems, such as queues and message buses.
• Focus on business logic, instead of the implementation details of interacting with a system.
• Keep your code free from SDKs or libraries.
• Handle retries and failure recovery.
• Switch between bindings at runtime.
• Build portable applications with environment-specific bindings set-up and no required code changes.

For example, with bindings, your application can respond to incoming Twilio/SMS messages without:

• Adding or configuring a third-party Twilio SDK
• Worrying about polling from Twilio (or using WebSockets, etc.)

In the above diagram:

• The input binding triggers a method on your application.
• Execute output binding operations on the component, such as "create".

Bindings are developed independently of Dapr runtime. You can view and contribute to the bindings.

Note

If you are using the HTTP Binding, then it is preferable to use service invocation instead. Read How-To: Invoke Non-Dapr Endpoints using HTTP for more information.

Input bindings

With input bindings, you can trigger your application when an event from an external resource occurs. An optional payload and metadata may be sent with the request.

The following overview video and demo demonstrates how Dapr input binding works.

To receive events from an input binding:

1. Define the component YAML that describes the binding type and its metadata (connection info, etc.).
2. Listen for the incoming event using:
   • An HTTP endpoint
   • The gRPC proto library to get incoming events.

Note

On startup, Dapr sends an OPTIONS request for all defined input bindings to the application. If the application wants to subscribe to the binding, Dapr expects a status code of 2xx or 405.

Read the Create an event-driven app using input bindings guide to get started with input bindings.

Output bindings

With output bindings, you can invoke external resources. An optional payload and metadata can be sent with the invocation request.

The following overview video and demo demonstrates how Dapr output binding works.

To invoke an output binding:

1. Define the component YAML that describes the binding type and its metadata (connection info, etc.).
2. Use the HTTP endpoint or gRPC method to invoke the binding with an optional payload.
3. Specify an output operation. Output operations depend on the binding component you use, and can include:
   • "create"
   • "update"
   • "delete"
   • "exec"

Read the Use output bindings to interface with external resources guide to get started with output bindings.

Binding directions (optional)

You can provide the direction metadata field to indicate the direction(s) supported by the binding component. In doing so, the Dapr sidecar avoids the "wait for the app to become ready" state, reducing the lifecycle dependency between the Dapr sidecar and the application:

• "input"
• "output"
• "input, output"

Note

It is highly recommended that all input bindings should include the direction property.

See a full example of the bindings direction metadata.

Try out bindings

Quickstarts and tutorials

Want to put the Dapr bindings API to the test? Walk through the following quickstart and tutorials to see bindings in action:

Start using bindings directly in your app

Want to skip the quickstarts? Not a problem. You can try out the bindings building block directly in your application to invoke output bindings and trigger input bindings. After Dapr is installed, you can begin using the bindings API starting with the input bindings how-to guide.

Next Steps

• Follow these guides on:
  • How-To: Trigger a service from different resources with input bindings
  • How-To: Use output bindings to interface with external resources
• Try out the bindings tutorial to experiment with binding to a Kafka queue.
• Read the bindings API specification

Last modified March 21, 2024: Merge pull request #4082 from newbe36524/v1.13 (f4b0938)