Update Webhook

Replace a webhook's configuration.

PUT

/api/v1/webhooks/{webhookId}

Replace a webhook's configuration. url is required, so send the current value for anything you are not changing. The secret is the exception: omit it to keep the one in place, or send null to stop signing deliveries. Events already queued for delivery are sent to the new URL.

Authorization

AuthorizationBasic <token>

Basic API key authentication. Create a new API key and secret in the Recommand dashboard.

In: header

Path Parameters

webhookId*string

The ID of the webhook to update

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

url*string

The HTTPS endpoint to deliver events to.

Formaturi

Example"https://example.com/hooks/recommand"

companyId?|

Limit the webhook to one company's events. Leave it out to receive the events of every company in the team.

Example"c_01JQZ8X0M4T7RB6K9V2NDHW3PA"

secret?|

New secret for the HMAC-SHA256 X-Signature header. Omit to preserve it or use null to disable signing.

Length1 <= length

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/webhooks/string" \  -H "Content-Type: application/json" \  -d '{    "url": "https://example.com/hooks/recommand"  }'

{  "success": true,  "webhook": {    "id": "wh_01JQZ8X0M4T7RB6K9V2NDHW3PA",    "teamId": "team_01JQZ8X0M4T7RB6K9V2NDHW3PA",    "companyId": null,    "url": "https://example.com/hooks/recommand",    "secret": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

404application/json

500application/json

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`