Twitter binding spec

Detailed documentation on the Twitter binding component

Component format

To setup Twitter binding create a component of type bindings.twitter. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: <NAME>
spec:
  type: bindings.twitter
  version: v1
  metadata:
  - name: consumerKey
    value: "****" # twitter api consumer key, required
  - name: consumerSecret
    value: "****" # twitter api consumer secret, required
  - name: accessToken
    value: "****" # twitter api access token, required
  - name: accessSecret
    value: "****" # twitter api access secret, required

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Binding support

This component supports both input and output binding interfaces.

This component supports output binding with the following operations:

• get

Input binding

For input binding, where the query matching Tweets are streamed to the user service, the above component has to also include a query:

  - name: query
    value: "dapr" # your search query, required

Output binding

get

For output binding invocation the user code has to invoke the binding:

POST http://localhost:3500/v1.0/bindings/twitter

Where the payload is:

{
  "data": "",
  "metadata": {
    "query": "twitter-query",
    "lang": "optional-language-code",
    "result": "valid-result-type"
  },
  "operation": "get"
}

The metadata parameters are:

• query - any valid Twitter query (e.g. dapr or dapr AND serverless). See Twitter docs for more details on advanced query formats
• lang - (optional, default: en) restricts result tweets to the given language using ISO 639-1 language code
• result - (optional, default: recent) specifies tweet query result type. Valid values include:
  • mixed - both popular and real time results
  • recent - most recent results
  • popular - most popular results

You can see the example of the JSON data that Twitter binding returns here

Related links

• Basic schema for a Dapr component
• Bindings building block
• How-To: Trigger application with input binding
• How-To: Use bindings to interface with external resources
• Bindings API reference

Last modified July 27, 2022: Remove namespace element from component examples (#2647) (ff9de5c8)