Events

Iron Plans can send your service webhook events when Customers take action, or important events are about to happen.  For example, you can receive an event when a Customer subscribes to one of your plans, when a subscription is renewed or cancelled, or if any payment fails.
Setup
 To receive webhook events, set a webhook URL in settings:
Webhook URL
A different URL can be set for Live Mode and Test Mode.
Verification
Webhook events are sent with a X-Signature header, with the value sha256=HASH .  HASH is a SHA-256 hashed string of the POST body using your most recently created private token as the secret key. By reproducing the hash on your side and checking it matches the X-Signature, you can verify that the webhook sender is Iron Plans.
Python
1
import hashlib
2
import hmac
3
​
4
# Get `private_token` from https://dash.ironplans.com/tokens
5
secret = str.encode(private_token)
6
​
7
body = str.encode(request.body)
8
​
9
# Create an expected signature
10
signature = hmac.new(secret, body, digestmod=hashlib.sha256).hexdigest()
11
​
12
# Verify sender
13
req_sig = request.headers.get('X-Signature')
14
assert len(req_sig) == 71
15
assert req_sig.startswith("sha256=")
16
assert req_sig.split("=")[1] == signature
Copied!
Retries
Webhook events are sent immediately after an action on the relevant resource occurs.  If the reply to the webhook is not 200 , then the event is considered not delivered, and will be retried again up to an hour later, for a total of 3 retries.    
Examples
Example Plan event
Plan events are sent every time a plan is created or modified in any way.
1
{
2
   "id":"5aea0015-1dd5-4a25-b017-0e661ac7bbcc",
3
   "event_type":"plan",
4
   "status":"updated",   
5
   "provider_id":"4a09520e-ae1a-4e1d-9541-a87e12fef6ee",
6
   "name":"Enterprise",
7
   "tier":0,
8
   "is_active":true,
9
   "is_public":false,
10
   "is_trial_allowed":true,
11
   "is_default":false,
12
   "is_self_serve":true,
13
   "redirect_url":null,
14
   "cta_text":null,
15
   "replace_plan_id":null,
16
   "per_year_price_cents":100000,
17
   "per_month_price_cents":50001,
18
   "features":[
19
      {
20
         "id":"d1111140-ac0b-4d37-b3f3-6f23743c5084",
21
         "is_active":false,
22
         "display":null,
23
         "sort":0,
24
         "feature":{
25
            "id":"d1530140-ac0b-4d37-b3f3-6f23743c5084",
26
            "provider_id":"4a09520e-ae1a-4e1d-9541-a87e12fef6ee",
27
            "slug":"requestss",
28
            "display":null,
29
            "tooltip":null,
30
            "is_builtin":true
31
         },
32
         "spec":{
33
            "id":"e1c2775e-1879-49a4-8eec-f3071dfd96be",
34
            "name":"Requests",
35
            "record_period":"monthly",
36
            "aggregation":"sum",
37
            "max_limit":0,
38
            "unit_price":10,
39
            "units_included":0,
40
            "provider_id":"4a09520e-ae1a-4e1d-9541-a87e12fef6ee"
41
         }
42
      }
43
   ],
44
   "teams_access":[]
45
}
Copied!
Example Subscription event
Subscription events are sent every time a customer creates a new subscription or modifies it any way.
1
{
2
   "id":"f74dba98-7fd2-4d44-8d66-cffbdbece386",
3
   "event_type":"subscription",
4
   "status":"updated",   
5
   "plan_id":"5aea0015-1dd5-4a25-b017-0e661ac7bbcc",
6
   "team_id":"75c489e7-cb32-48c0-956c-4b1e9f6294fb",
7
   "start_at":"2021-09-16T04:32:52.244102Z",
8
   "end_at":"2021-09-02T20:00:09.320993Z",
9
   "is_paused":false,
10
   "is_active":false,
11
   "next_plan_id":null,
12
   "cancel_on":null,
13
   "plan":{
14
      "id":"5aea0015-1dd5-4a25-b017-0e661ac7bbcc",
15
      "provider_id":"4a09520e-ae1a-4e1d-9541-a87e12fef6ee",
16
      "name":"Enterprise",
17
      "tier":0,
18
      "is_active":true,
19
      "is_public":false,
20
      "is_trial_allowed":true,
21
      "is_default":false,
22
      "is_self_serve":true,
23
      "redirect_url":null,
24
      "cta_text":null,
25
      "replace_plan_id":null,
26
      "per_year_price_cents":100000,
27
      "per_month_price_cents":50001,
28
      "features":[
29
         {
30
            "id":"d1111140-ac0b-4d37-b3f3-6f23743c5084",
31
            "is_active":false,
32
            "display":null,
33
            "sort":0,
34
            "feature":{
35
               "id":"d1530140-ac0b-4d37-b3f3-6f23743c5084",
36
               "provider_id":"4a09520e-ae1a-4e1d-9541-a87e12fef6ee",
37
               "slug":"requestss",
38
               "display":null,
39
               "tooltip":null,
40
               "is_builtin":true
41
            },
42
            "spec":{
43
               "id":"e1c2775e-1879-49a4-8eec-f3071dfd96be",
44
               "name":"Requests",
45
               "record_period":"monthly",
46
               "aggregation":"sum",
47
               "max_limit":0,
48
               "unit_price":10,
49
               "units_included":0,
50
               "provider_id":"4a09520e-ae1a-4e1d-9541-a87e12fef6ee"
51
            }
52
         }
53
      ],
54
      "teams_access":[]
55
   }
56
}
Copied!
Example Plan Contact Us event
For Enterprise style plans where the call to action is a "Contact Us" button, we send webhook events that capture the input form data.
1
{
2
   "event_type": "plan_contact_us",
3
   "email": "[email protected]",
4
   "company_name": "Big Co."
5
}   
Copied!