SMS Inbound API

SMS Inbound Webhooks

Senest redigeret:

Introduction

Webhooks allow you to build or set up a web service (perhaps in relation to your CRM), which subscribes to certain events in OnlineFundraising.

When the listed events are triggered, OnlineFundraising will send a HTTP POST payload to the configured webhook URL from IPs listed here: https://s3.eu-central-1.amazonaws.com/dk.onlinefundraising.info/webhooks.json

Please note webhooks may be delivered twice in rare occasions, due to connection problems, bad timings etc. Please also see delivery attempts below.

Event types

Currently only one webhook is available in Inbound. More may be added in the future.

Entity

Event type

Description

SmsMO

received

A text message was received.

Webhook payload

One or more objects may be delivered in a single webhook.

Example of POST delivery

[
    {
        "messageGuid": "17934114-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "createdTs": "2021-02-10 13:33:23 +0100",
        "channel": "1217",
        "keyword": "STØT",
        "receivedText": "Støt",
        "keywordGuid": "3b03ac9a-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "state": "Processed",
        "msisdn": "4540xxxxxx",
        "merchantId": "min_organisation",
        "campaignGuid": "9b6ae17d-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "processedTs": "2021-02-10 13:33:23 +0100"
    },
    {
        "messageGuid": "17944524-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "createdTs": "2021-02-10 11:22:44 +0100",
        "channel": "1217",
        "keyword": "Hjælp",
        "receivedText": "hjælp",
        "keywordGuid": "00799975-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "state": "Processed",
        "msisdn": "4520xxxxxx",
        "merchantId": "min_organisation",
        "campaignGuid": "9975e17d-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "processedTs": "2021-02-10 11:22:44 +0100"
    }
]

Webhook delivery attempts

Should your integration not respond at all or respond with a HTTP code other than 200 OK, then we will resend the webhook by an exponential backoff algorithm with the following seconds interval per attempt:

    1. 10
    2. 1800
    3. 3600
    4. 5400
    5. 7200
    6. 9000
    7. 10800
    8. 12600
    9. 14400
    10. 16200

 

Was this article helpful?

0 out of 0 found this helpful