Migrating Callbacks

All callback urls created in the v1 endpoint will continue to remain valid when migrating to the v2 API. The v2 suite provides additional functionalities to validate the endpoint using authentication token and provides functionalities to suppress the non-required events.

Add a URL endpoint

POST /v1/callback/urls?urls="https://companydomain.io"

POST /v2/callback/

{
  "url": "https://companydomain.io/signeasywebhookep",
  "events": ["rs.signed", "rs.completed"],
  "token": "myloooooooongtokenbiggerthan12chars"
}

List all callbacks

Notice the information about the events and the token being sent in the response for the associated callback.

GET /v1/callback/urls

{
    "callback_urls": [
        "https://companydomain.io"
    ]
}

GET /v2/callback/

{
    "callback_urls": [
        "https://google.com",
        "https://companydomain.io/signeasywebhookio"
    ],
    "https://companydomain.io/signeasywebhookio": {
        "token": "myloooooooongtokenbiggerthan12chars",
        "events": [
            "rs.completed",
            "rs.signed"
        ]
    }
}

Update a callback

The v1 API suite did not support updating an endpoint to suppress events. However you can choose to update existing URLs to add the tokens / suppress events.

PUT /v2/callback/

{
  "url": "https://companydomain.io/signeasywebhookep",
  "events": ["rs.signed", "rs.completed"],
  "token": "myloooooooongtokenbiggerthan12chars"
}

Remove a callback

DELETE /v1/callback/urls?urls="https://companydomain.io"

DELETE /v2/callback/

{
  "url": "https://companydomain.io/signeasywebhookep"
}