POST
/
webhooks
/
{id}
curl --request POST \
  --url http://staging.api.commenda.io/api/v1/webhooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "api_version": "<string>",
  "name": "<string>",
  "topics": [
    "INCORPORATION_REQUEST.SUCCEEDED"
  ],
  "status": "ENABLED"
}'
{
  "message": "Successfully updated webhook."
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The unique identifier of the webhook to update.

Body

application/json
​
api_version
string

The version of the API for which you registered the webhook. This helps to maintain backward compatibility. If in newer versions the event payload is changed, your webhook will keep receiving the payload from this api version. This will be 'v1.0' for now and we will come up with more versions and a changelog later.

​
name
string

Optional name to define the purpose of the webhook.

​
topics
enum<string>[]

An array of topics to listen to. When any of these topics are triggered, the webhook will be pinged.

Available options:
INCORPORATION_REQUEST.SUCCEEDED,
INCORPORATION_REQUEST.NEEDS_ADDITIONAL_INFO,
INCORPORATION_REQUEST.COMPLETED
​
status
enum<string>

If the webhook is active or not. If a webhook is disabled it won't be called when a topic is triggered.

Available options:
ENABLED,
DISABLED

Response

200
application/json
Sales tax registration response
​
message
string
Example:

"Successfully updated webhook."