Skip to main content
PATCH
/
api
/
v1
/
webhooks
UpdateWebhook
curl --request PATCH \
  --url https://your-sift-api-url.com/api/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "webhook": {
    "webhookId": "<string>",
    "organizationId": "<string>",
    "targetUrl": "<string>",
    "name": "<string>",
    "eventType": "WEBHOOK_EVENT_TYPE_UNSPECIFIED",
    "payload": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "archivedDate": "2023-11-07T05:31:56Z",
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>",
    "httpHeaders": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  },
  "updateMask": "<string>"
}'
{
  "webhook": {
    "webhookId": "<string>",
    "organizationId": "<string>",
    "targetUrl": "<string>",
    "name": "<string>",
    "eventType": "WEBHOOK_EVENT_TYPE_UNSPECIFIED",
    "payload": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "archivedDate": "2023-11-07T05:31:56Z",
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>",
    "httpHeaders": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

The request for a call to WebhookService_UpdateWebhook to update a webhook.

​
webhook
object
required
​
updateMask
string
required

The list of fields to be updated. The fields available to be updated are 'target_url', 'name', 'event_type', 'payload', 'http_headers', 'archived_date'.

Response

A successful response.

The response of a call to WebhookService_UpdateWebhook. To archive a webhook, specify archived_date in the update mask as well as a non-null value for archived_date in the webhook object. To unarchive a webhook, specify archived_date in the update mask and a null value for archived_date in the webhook object.

​
webhook
object
required