Twilio SendGrid binding spec

Detailed documentation on the Twilio SendGrid binding component

Component format

To setup Twilio SendGrid binding create a component of type bindings.twilio.sendgrid. See this guide on how to create and apply a binding configuration.

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Component
  3. metadata:
  4. name: sendgrid
  5. namespace: default
  6. spec:
  7. type: bindings.twilio.sendgrid
  8. version: v1
  9. metadata:
  10. - name: emailFrom
  11. value: "testapp@dapr.io" # optional
  12. - name: emailTo
  13. value: "dave@dapr.io" # optional
  14. - name: subject
  15. value: "Hello!" # optional
  16. - name: apiKey
  17. value: "YOUR_API_KEY" # required, this is your SendGrid key

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

FieldRequiredBinding supportDetailsExample
apiKeyYOutputSendGrid API key, this should be considered a secret value“apikey”
emailFromNOutputIf set this specifies the ‘from’ email address of the email message. Optional field, see below“me@example.com”
emailToNOutputIf set this specifies the ‘to’ email address of the email message. Optional field, see below“me@example.com”
emailCcNOutputIf set this specifies the ‘cc’ email address of the email message. Optional field, see below“me@example.com”
emailBccNOutputIf set this specifies the ‘bcc’ email address of the email message. Optional field, see below“me@example.com”
subjectNOutputIf set this specifies the subject of the email message. Optional field, see below“subject of the email”

Binding support

This component supports output binding with the following operations:

  • create

Example request payload

You can specify any of the optional metadata properties on the output binding request too (e.g. emailFrom, emailTo, subject, etc.)

  1. {
  2. "metadata": {
  3. "emailTo": "changeme@example.net",
  4. "subject": "An email from Dapr SendGrid binding"
  5. },
  6. "data": "<h1>Testing Dapr Bindings</h1>This is a test.<br>Bye!"
  7. }

Related links

Last modified March 18, 2021: Merge pull request #1321 from dapr/aacrawfi/logos (9a399d5)