Webhook Payload Examples

πŸ“˜

Webhook Guides

Looking for a webhook overview or how to create a call in Simon? Click here.

Object Example

Payload Encoding: JSON
Request type: Batch
Batch size: 500
Payload type: Object
Payload key: simonDataTest
Payload of:
first_name: simon - String
last_name: data - String
nested_metadata.age: 4 - Number
nested_metadata.size: 50 - Number

{
    "simonDataTest": [
        {
            "first_name": "simon",
            "last_name": "data",
            "nested_metadata": {
                "age": 4,
                "size": 50
            }

        },
        ... repeat for 499 more contacts ...
    ]
}

Array Example

Payload Encoding: JSON
Request type: Batch
Batch size: 500
Payload type: Array
Payload of:
first_name: simon - String
last_name: data - String
nested_metadata.age: 4 - Number
nested_metadata.size: 50 - Number

[
        {
            "first_name": "simon",
            "last_name": "data",
            "nested_metadata": {
                "age": 4,
                "size": 50
            }
        },
        ... repeat for 499 more contacts ...
]

Single Request Type Example

Payload Encoding: JSON
Request type: Single
Payload of:
first_name: simon - String
last_name: data - String
nested_metadata.age: 4 - Number
nested_metadata.size: 50 - Number

{
    "first_name": "simon",
    "last_name": "data",
    "nested_metadata": {
        "age": 4,
        "size": 50
    }
}

Form-Encoded, Single Request Type

Payload Encoding: Form-encoded
Request type: Single
Payload of:
From: +11234567890 - String
To: +12223334444 - String
Body: Thanks for signing up! - String

$ curl -X POST https://example.com \
--data-urlencode "Body=Thanks for signing up!" \
--data-urlencode "From=+11234567890" \
--data-urlencode "To=+12223334444" \
-u AUTH_TOKEN:$AUTH_SECRET