Deactivate a webhook | The Penny Inc

curl -X PATCH https://sandbox.api.thepennyinc.com/notifications/webhooks/notification_endpoint_id/deactivate \
     -H "X-Penny-As-Business: business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71" \
     -H "Authorization: Bearer <token>"

{
  "notification_endpoint_id": "notification_endpoint_01937bc8-3624-739c-85ca-362439c5ca2e",
  "version": 1,
  "version_time": "2024-01-15T10:30:00Z",
  "business_id": "business_01937b95-484e-75af-8c68-484e5afc68d3",
  "status": "pending_setup",
  "enabled": true,
  "updating": true,
  "archived": false,
  "created_time": "2024-01-15T10:30:00Z",
  "verification": {
    "verified": true,
    "failed": true,
    "reason": "The endpoint returned HTTP 500 after 3 retries."
  },
  "suspension": {
    "suspended": true,
    "reason": "Account flagged for suspicious activity"
  },
  "channel": "webhook",
  "url": "https://api.acme.example/webhooks/penny",
  "has_authentication_token": true,
  "has_signing_secret": true,
  "trigger_events": [
    "string"
  ],
  "filter_identifiers": [
    "string"
  ]
}

Disable webhook deliveries without archiving the endpoint.

Required permissions: notification_endpoint:update.

Authentication

AuthorizationBearer

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

Path parameters

notification_endpoint_idstringRequired

The ID of the webhook endpoint.

Query parameters

reveal_sensitivebooleanOptionalDefaults to false

Whether to include unmasked sensitive fields in the response. Defaults to false.

Response

The deactivated webhook.

notification_endpoint_idstring

Penny's unique identifier for this endpoint.

versioninteger

A number that increases each time this endpoint's details change. Use it to confirm you are looking at the latest information.

version_timedatetime

The date and time this endpoint's details were last changed.

business_idstring

The business this endpoint belongs to.

statusenum

This endpoint’s current status: ‘pending_setup’, ‘setup_failed’, ‘pending_verification’, ‘verification_failed’, ‘updating’, ‘active’, ‘deactivated’, ‘suspended’, or ‘archived’.

enabledboolean

Whether this endpoint currently receives deliveries.

updatingboolean

Whether this endpoint is currently being updated.

archivedboolean

Whether this endpoint has been permanently retired.

created_timedatetime

When this endpoint was registered.

verificationobject

The ownership-verification state of this endpoint.

suspensionobject

Whether this endpoint is currently suspended, and why.

channelenum

The delivery channel for this endpoint.

Allowed values:

urlstring

The HTTPS URL event payloads are delivered to. Shown as a masked placeholder unless the request explicitly asks to reveal sensitive values.

has_authentication_tokenboolean

Whether a bearer authentication token is configured. The token is write-only and is never returned.

has_signing_secretboolean

Whether a signing secret is configured. The secret is returned only when created or rotated.

trigger_eventslist of stringsOptional

The events this endpoint is subscribed to.

filter_identifierslist of stringsOptional

The specific objects this endpoint's subscription is scoped to, if any. Empty means it receives events for every object.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors