Rotate the signing secret

POST

/webhooks/{id}/rotate-secret

const url = 'https://api.vaartix.com/webhooks/wh_4n8x2k7q1m9c3v5d/rotate-secret';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.vaartix.com/webhooks/wh_4n8x2k7q1m9c3v5d/rotate-secret \
  --header 'Authorization: Bearer <token>'

Creates a new signing secret. The old one stops working immediately.

Authorizations

apiKey

Parameters

Path Parameters

required

string

Example

wh_4n8x2k7q1m9c3v5d

Responses

200

The endpoint with its new secret.

application/json

object

string

url

string format: uri

events

Array<string>

Allowed values: email.sent email.delivered email.delivery_delayed email.bounced email.complained email.rejected email.rendering_failure email.suppressed email.opened email.clicked

status

Endpoints are turned off automatically after 5 deliveries in a row fail every attempt.

string

Allowed values: enabled disabled

createdAt

string format: date-time

secret

required

The signing secret. Shown only when created or rotated.

string

Example

{
  "id": "wh_4n8x2k7q1m9c3v5d",
  "events": [
    "email.sent"
  ],
  "status": "enabled",
  "secret": "whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw"
}

401

unauthorized: the API key is missing, invalid or revoked.

application/json

object

error

required

object

type

required

Stable, machine-readable error type.

string

Allowed values: validation_error unauthorized forbidden not_found conflict rate_limited daily_quota_exceeded domain_not_verified invalid_from_address account_paused domain_needs_review content_rejected idempotency_conflict bad_request internal_error

message

required

Human-readable explanation, safe to show to developers.

string

Example

{
  "error": {
    "type": "validation_error"
  }
}

403

forbidden: the key cannot do this, for example a send-only key on a management endpoint.

application/json

object

error

required

object

type

required

Stable, machine-readable error type.

string

message

required

Human-readable explanation, safe to show to developers.

string

Example

{
  "error": {
    "type": "validation_error"
  }
}

404

not_found: no such resource in your team.

application/json

object

error

required

object

type

required

Stable, machine-readable error type.

string

message

required

Human-readable explanation, safe to show to developers.

string

Example

{
  "error": {
    "type": "validation_error"
  }
}