Delete a webhook subscription

DELETE/v1/api/store/{team_slug}/setting/webhook_subscription/{hash_id}

v1Operation ID v1_public_webhook_subscription_destroy

Deletes a subscription for good, with its delivery log.

No more events are sent to it, and pending retries stop. After the delete, YoPrint sends one DELETE request to the subscription's URL (no body, no signature, User-Agent: YoPrint Webhooks Agent, 3-second timeout, redirects not followed), if its host still resolves only to public internet addresses. Any answer, or none, is ignored.

Permission

Needs the Manage Settings permission.

Side effects

• Sends one unsigned DELETE request to the subscription's URL, unless its host no longer resolves to public internet addresses only.
• Deletes the subscription's delivery log.
• Deleting a zapier subscription stops that Zap's events. To remove a Zap's subscription cleanly, turn the Zap off in Zapier: Zapier then deletes the subscription itself.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• hash_idstringrequired

  The webhook subscription's id: a hash id from an earlier answer. Only hash ids work here; anything else answers 404 page_not_found.

  • Example V4keXwwxMQyXw7

Request body

This operation takes no request body.

Response

200Successful response.

• datanullrequired
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

  When

  The API key is missing or wrong.

  Fix

  Send your personal API key as Authorization: Bearer YOUR_API_KEY.

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

  When

  Your permission group lacks Manage Settings. This 403 has a short body, {"message": "Insufficient Permission"}, without success or error.

  Fix

  Ask the team owner to give your permission group Manage Settings.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

  When

  No webhook subscription with that id on this team (error.code is null and error.message starts "No query results"), the id is not one of this team's hash ids, or you are not a member of the team (both page_not_found).

  Fix

  Use an id from the list operation and check the team slug.

Notes

• Deleting cannot be undone. To stop deliveries for a while, set status to disabled instead.
• Your endpoint should not treat an unsigned DELETE as an event.

Related

• PATCHTouch a webhook subscription/v1/api/store/{team_slug}/setting/webhook_subscription/{hash_id}

Example request

curl

curl -X DELETE 'https://secure.yoprint.com/v1/api/store/your-team/setting/webhook_subscription/V4keXwwxMQyXw7' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": null,
  "status": 200,
  "success": true
}