Update a webhook subscription

​

Change the callback URL, selected events, installer or active status. Omitted fields keep their current values. Send If-Match with the ETag from a create or update response, or from a subscription GET when you have none. A write-only creator can reuse the create ETag; a GET needs admin:read. A 412 response means the subscription changed and must be read again.

Path Parameters

Headers

  • ETag from a create or update response you already have, or from the latest GET when you have none.

Body

required
application/json
  • New public HTTPS callback URL. Omit to keep the current address.

  • Replace custom headers. Send an empty object to remove all custom headers. Values are write-only.

    Properties: 1
  • Webhook events your callback should receive.

    values
    • project-created
    • project-updated
    • design-help-started
    • design-help-ended
    • proposal-sent
    • contract-sent
    • contract-signed
    • contract-change-order-sent
  • Installer in your organization that owns the subscription.

  • Set false to pause the subscription or true to enable it.

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for patch/external/v2/webhook-subscriptions/{webhookSubscriptionId}
curl https://sales-api.artemis.solar/external/v2/webhook-subscriptions/123e4567-e89b-12d3-a456-426614174000 \
  --request PATCH \
  --header 'If-Match: "copy-the-etag-from-your-latest-get"' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_SECRET_TOKEN' \
  --data '{
  "isActive": false
}'
Subscription paused
{
  "data": {
    "id": "79c336cf-4067-44af-af39-c235db33aae2",
    "callbackUrl": "https://integrations.example.com/webhooks/artemis",
    "callbackHasQuery": false,
    "apiMethod": "POST",
    "eventTypes": [
      "project-created",
      "project-updated",
      "design-help-started",
      "design-help-ended"
    ],
    "authType": "hmac",
    "hasAuthCredentials": true,
    "customHeaderNames": [],
    "isActive": false,
    "installerId": "f7b7db62-29bf-4e70-bf73-a9221674f12a",
    "contractVersion": 2,
    "createdAt": "2026-09-05T12:00:00.000Z",
    "updatedAt": "2026-09-05T12:01:00.000Z"
  }
}