docs/daprdocs/content/en/reference/components-reference/supported-bindings/twitter.md

type	title	linkTitle	description	aliases
docs	Twitter binding spec	Twitter	Detailed documentation on the Twitter binding component	/operations/components/setup-bindings/supported-bindings/twitter/

Component format

To setup Twitter binding create a component of type bindings.twitter. See [this guide]({{< ref "howto-bindings.md#1-create-a-binding" >}}) 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

{{% alert title="Warning" color="warning" %}} The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described [here]({{< ref component-secrets.md >}}). {{% /alert %}}

Spec metadata fields

Field	Required	Binding support	Details	Example
consumerKey	Y	Input/Output	Twitter API consumer key	"conusmerkey"
consumerSecret	Y	Input/Output	Twitter API consumer secret	"conusmersecret"
accessToken	Y	Input/Output	Twitter API access token	"accesstoken"
accessSecret	Y	Input/Output	Twitter API access secret	"accesssecret"

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]({{< ref component-schema >}})
• [Bindings building block]({{< ref bindings >}})
• [How-To: Trigger application with input binding]({{< ref howto-triggers.md >}})
• [How-To: Use bindings to interface with external resources]({{< ref howto-bindings.md >}})
• [Bindings API reference]({{< ref bindings_api.md >}})