Let's Talk Book a Demo

PUT Update a Callback

Update a callback that was already set up for your API-Key.

Page actions
View as MarkdownOpen the local plain-text source Open in ChatGPTAsk about this public documentation page Open in ClaudeAsk about this public documentation page
Browse documentation
On this page 

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

This endpoint allows you to update a previously created callback for your 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
Path Parameters Type Description
event string Input one of the Supported Events, view the list here.
Body Parameters Type Description
url string Your callback Endpoint URL to receive the events
method (optional) string The method to be used, POST is the default if not provided
headers (optional) string Enter the authentication headers to be included (API key, token)
payload (optional) string Attributes to send along with the default payload for the Supported Events

Sample Response (200: Ok)

{
    "api_key": "<your_request_api_key>",
    "event": "SESSION:STAGE_CHANGE",
    "url": "https://your_sms_callback_url",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer <jwt_token>"
    },
    "payload": {
        "source": "PAVE", // additional attributes to pass along; setting on create callback
    }
}

Sample Response (400: Bad Request)

{
    "message": "Missing required fields."
}

Sample Response (404: Not Found)

{
    "api_key": "<your_request_api_key",
    "message": "Your API Key does not have callback setting for the event :event."
}