Basic Usage

Search…
Basic Usage
Reactions are configured to react to a specific event and trigger an action whenever that event is processed by the event reactor. An example could be sending a confirmation email to a customer when an order has been successfully placed.
It is not possible for a Reaction to trigger on an event that has happened in the past. Reactions are always configured to listen to events from the moment when the Reaction is configured.
Actions
Each reaction is configured with a specific Action that defines what will happen when the reaction is triggered. When a Reaction is triggered it will execute its configured Action.
Currently Serialized offer four pre-defined action types, for Slack, IFTTT, Automate and Zapier, and a generic HTTP action for any system capable of receiving HTTP POST:s.
HTTP Action
The action type (HTTP_POST) requires the field targetUri to be populated with the address that should receive the POST request. Optionally the field httpHeaders can be set, i.e. to handle Basic Authentication etc.
Request signing
All outgoing HTTP request will automatically be HMAC signed using the reaction name as the signing key. To provide your own signing secret, include the field signingSecret in the action payload.
Receiving reaction requests
The reaction requests are HTTP POST requests with a JSON body. The JSON has the following format:
1
{  
2
   "metadata":{  
3
      "aggregateId":"<some-aggregate-id>",
4
      "timestamp": <epoc-millis>,
5
      "sequenceNumber": <n>
6
   },
7
   "event":{  
8
      "eventId":"<some-event-id>",
9
      "eventType":"<event-type>",
10
      "data":{  
11
         "key":"value",
12
         "key":"value",
13
         ...
14
      }
15
   }
16
}
Copied!
Securing the external endpoint
As the end-point specified in the targetUri must be exposed to the public internet it should be protected. Currently it’s possible to utilize Basic Authentication and include the appropriate HTTP header in the Reaction definition.
1
{
2
  "reactionName": "notify-on-order-shipped",
3
  "feedName": "order",
4
  "reactOnEventType": "OrderShippedEvent",
5
  "action": {
6
    "actionType": "HTTP_POST",
7
    "targetUri": "https://your-service",
8
    "signingSecret": "my-optional-signing-key",
9
    "httpHeaders": {
10
      "Authorization": "Basic c2VasXlZdyW2dGsONfM5fD4adleRDgVbDNgRkgFgZUpgoxgNHdsg15QktFcm1ndjI="
11
    }    
12
  }
13
}
Copied!
Slack Action
The action type (SLACK_POST) requires the field targetUri to be populated with a valid Slack webhook URI. The message text is specified in the field body. Simple templating is supported and event data can be accessed using dot (.) notation.
Example of a Reaction posting a notification to Slack:
1
{
2
  "reactionName": "on-order-placed-slack-notifier",
3
  "feedName": "order",
4
  "reactOnEventType": "OrderPlacedEvent",
5
  "action": {
6
    "actionType": "SLACK_POST",
7
    "targetUri": "https://hooks.slack.com/services/T0000/B0000/XXXX",
8
    "body": "A new order with number ${event.data.orderNumber} was placed by ${event.data.customer.email}!"
9
  }
10
}
Copied!
Given this event:
1
{
2
  "eventId": "ca37d05c-a852-4de5-961f-16fb35e8cd7b",
3
  "eventType": "OrderPlacedEvent",
4
  "data": {  
5
    "orderNumber": "12312345",
6
    "customer": {
7
      "email": "[email protected]"
8
    }
9
  }
10
}
Copied!
the message to Slack will look like this:
A new order with number 12312345 was placed by [email protected]!
IFTTT Action
The action type (IFTTT_POST) requires the field targetUri to be populated with a valid IFTTT webhook URI (i.e. starting with https://maker.ifttt.com/trigger). The map valueMap is used for storing the (up to three) dynamic values supported by IFTTT. Simple templating is supported and event data can be accessed using dot (.) notation.
Example of a Reaction posting a request to IFTTT:
1
{
2
  "reactionName": "ifttt-payment-notifier",
3
  "feedName": "payment",
4
  "reactOnEventType": "CaptureCompleted",
5
  "action": {
6
    "actionType": "IFTTT_POST",
7
    "targetUri": "https://maker.ifttt.com/trigger/payment_notification/with/key/<your-key>",
8
    "valueMap": {
9
      "value1": "Payment made by ${event.data.customerId} with amount ${event.data.amount}.",
10
      "value2": "Some more data",
11
      "value3": "Even more..."
12
    }
13
  }
14
}
Copied!
Given this event:
1
{
2
  "eventId": "ca37d05c-a852-4de5-961f-16fb35e8cd7b",
3
  "eventType": "CaptureCompleted",
4
  "data": {  
5
    "customerId": "some-test-id-1",
6
    "amount": 12345
7
  }
8
}
Copied!
the request body POST:ed to IFTTT would look like this:
1
{
2
  "value1": "Payment made by some-test-id-1 with amount 12345.",
3
  "value2": "Some more data",
4
  "value3": "Even more..."
5
}
Copied!
Automate Action
The action type (AUTOMATE_POST) requires the field targetUri to be populated with a valid Automate.io webhook URI (i.e. starting with https://wh.automate.io/webhook). The map valueMap is used for storing the (up to nine) dynamic values. Simple templating is supported and event data can be accessed using dot (.) notation.
Example of a Reaction posting a request to Automate.io:
1
{
2
  "reactionName": "automate-payment-notifier",
3
  "feedName": "payment",
4
  "reactOnEventType": "CaptureCompleted",
5
  "action": {
6
    "actionType": "AUTOMATE_POST",
7
    "targetUri": "https://wh.automate.io/webhook/<your-key>",
8
    "valueMap": {
9
      "value1": "Payment made by ${event.data.customerId} with amount ${event.data.amount}.",
10
      ...
11
      "value9": "Some more data"
12
    }
13
  }
14
}
Copied!
Given this event:
1
{
2
  "eventId": "ca37d05c-a852-4de5-961f-16fb35e8cd7b",
3
  "eventType": "CaptureCompleted",
4
  "data": {  
5
    "customerId": "some-test-id-1",
6
    "amount": 12345
7
  }
8
}
Copied!
the request body POST:ed to Automate.io would look like this:
1
{
2
  "value1": "Payment made by some-test-id-1 with amount 12345.",
3
  ...
4
  "value9": "Some more data"
5
}
Copied!
Zapier Action
The action type (ZAPIER_POST) requires the field targetUri to be populated with a valid Zapier webhook URI (i.e. starting with https://hooks.zapier.com/hooks). The map valueMap is used for storing the (up to nine) dynamic values. Simple templating is supported and event data can be accessed using dot (.) notation.
Example of a Reaction posting a request to Automate.io:
1
{
2
  "reactionName": "zapier-payment-notifier",
3
  "feedName": "payment",
4
  "reactOnEventType": "CaptureCompleted",
5
  "action": {
6
    "actionType": "ZAPIER_POST",
7
    "targetUri": "https://hooks.zapier.com/hooks/catch/<your-key>",
8
    "valueMap": {
9
      "value1": "Payment made by ${event.data.customerId} with amount ${event.data.amount}.",
10
      ...
11
      "value9": "Some more data"
12
    }
13
  }
14
}
Copied!
Given this event:
1
{
2
  "eventId": "ca37d05c-a852-4de5-961f-16fb35e8cd7b",
3
  "eventType": "CaptureCompleted",
4
  "data": {  
5
    "customerId": "some-test-id-1",
6
    "amount": 12345
7
  }
8
}
Copied!
the request body POST:ed to Zapier would look like this:
1
{
2
  "value1": "Payment made by some-test-id-1 with amount 12345.",
3
  ...
4
  "value9": "Some more data"
5
}
Copied!
Automatic retries
Serialized Reactions have a built-in retry mechanism and will be retried several times over the course of a day. A 2xx response is required for success, whereas a 4xx or 5xx response will be treated as an error and retried.
You can see all retries and any errors for your executed reactions in the Serialized Console.
APIS - Previous
Reactions API
Configuring execution time
Last modified 2yr ago
Copy link
Contents
Actions
HTTP Action
Request signing
Receiving reaction requests
Securing the external endpoint