GET All Callbacks

See all callbacks created for your API-Key

https://openapi.paveapi.com/v1/callbacks

This endpoint allows you to get all callback settings from requesting API Key.

Headers

API-Key

string

The API-Key that was provided for your account

API-Token

string

The API-Token used when the session was created

API-Timestamp

string

UTC Datetime string, example: 2021-05-30T12:49:19Z

Sample Response (200:Ok)

{
    "api_key": "<your_requested_api_key>",
    "data": [
        {
            "event": "SESSION:SMS_PROCESS",
            "url": "https://your_sms_callback_url",
            "method": "POST",
            "headers": {
                "Authorization": "Bearer <jwt_token>"
            },
            "payload": {
                "phone": "<session_to_phone>", // original payload we sent to Twilio
                "status": "<success_or_error>", // delivery status from Twilio
                "message": "<error_message>", // optional; probably error message
                "source": "PAVE", // additional attributes to pass along; setting on create callback
            }
        },
        {
            "event": "SESSION:STAGE_CHANGE",
            "url": "https://your_sms_callback_url",
            "method": "POST",
            "headers": {
                "Authorization": "Bearer <jwt_token>"
            },
            "payload": {
                "session_key": "",
                "photo_url": "",
                "photo_status": "",
                "message": "<rejected_message>", // optional; probably rejected message
                "source": "PAVE", // additional attributes to pass along; setting on create callback
            }
        }
    ]
}

Last updated