Modify a webhook
This endpoint modify an existing webhook. It returns the webhook object.
Path parameters
-
webhookId string Required
Specify the ID of the webhook to modify.
Body
-
targetUrl string Required
The URL of the webhook endpoint.
-
types array[string]
The list of events to enable for this endpoint.
Values are
created
,statusChanged
,portalSubmited
,dueDateChanged
,portalViewed
,docUploaded
,docDeleted
,itemApproved
,itemRejected
,itemReopened
,itemCancelValidation
,formSubmited
,emailSent
,emailClicked
,emailBounced
,emailOpened
,emailMarkedAsSpam
,emailBlocked
,emailUnsub
,smsSent
,smsDelivered
,smsClicked
,smsFailed
, orsmsUndelivered
. -
campaignId string
We'll call this endpoint only for this campaignId.
-
secretToken string
If you specify a secret token, it will be sent with the hook request in the HTTP header.
-
status string
The status of the webhook. It can be active or paused
Values are
active
orpaused
.
Responses
-
• 200 object
Success
-
• 400
Bad Request -- Your request is invalid.
-
• 401
Unauthorized -- Your API key is wrong.
-
• 403
Forbidden -- The object requested is hidden for administrators only.
-
• 404
Not Found -- The specified object could not be found.
-
• 429
Too Many Requests -- You're requesting too many objects! Slow down!
-
• 500
Internal Server Error -- We had a problem with our server. Try again later.
-
• 503
Service Unavailable -- We're temporarily offline for maintenance. Please try again later.
curl \
-X POST https://api.usecollect.com/v1/webhooks/{webhookId} \
--user "username:password" \
-H "Content-Type: application/json" \
-d '{"status":"paused"}'
{
"status": "paused"
}
{
"_id": "eqQkPdnqwN7J38QEx",
"targetUrl": "https://yourserver.com/collect-hook",
"status": "paused",
"types": [
"created",
"statusChanged",
"dueDateChanged"
],
"createdAt": "2022-07-13 15:01:38 UTC"
}