Reactivate Webhook Endpoint

POST

/api/:account_id/webhook-endpoints/:external_id/reactivate

Reactivate a blacklisted webhook endpoint.

Clears the blacklist status (is_blacklisted=False, consecutive_failures=0) and ensures the endpoint is active. Use this after fixing the receiving server issues that caused the blacklisting.

Authentication

AuthorizationBearer

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

Path parameters

external_idstringRequired

account_idstringRequired

Response

Successful Response

idstring

Unique webhook endpoint identifier

urlstring

The URL receiving webhook events

eventslist of strings

List of subscribed event types

is_activeboolean

Whether the webhook endpoint is active

is_protectedboolean

Whether the webhook endpoint is protected from deletion

is_blacklistedboolean

Whether the webhook endpoint is blacklisted due to consecutive delivery failures

consecutive_failuresinteger

Number of consecutive delivery failures (resets on success)

created_atdatetime

When the webhook endpoint was created

updated_atdatetime

When the webhook endpoint was last updated

descriptionstring or nullOptional

Webhook endpoint description

blacklisted_atdatetime or nullOptional

When the webhook endpoint was blacklisted (null if not blacklisted)

last_failed_deliveryobject or nullOptional

Information about the last failed delivery (only included for blacklisted endpoints)

Errors

422

Unprocessable Entity Error

$	curl -X POST https://app.paymentkit.com/api/account_id/webhook-endpoints/external_id/reactivate \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"id": "whe_prod_9f8e7d6c5b4a3210",
3	"url": "https://webhooks.myapp.com/receive",
4	"events": [
5	"payment.succeeded",
6	"payment.failed"
7	],
8	"is_active": true,
9	"is_protected": false,
10	"is_blacklisted": false,
11	"consecutive_failures": 0,
12	"created_at": "2024-04-10T12:00:00Z",
13	"updated_at": "2024-04-25T08:45:00Z",
14	"description": "Primary production webhook endpoint",
15	"blacklisted_at": null,
16	"last_failed_delivery": null
17	}