Webhooks

Create or update webhook

Set the webhook URL for the current user. Creates a new webhook if none exists, or updates the URL and rotates the secret if one already exists. A 'ping' event is dispatched immediately after saving.

The secret in the response is only provided on create/update, the client must store it securely. Use X-Webhook-Signature header to verify subsequent deliveries.

PUT
/webhooks

Authorization

token_auth
AuthorizationBearer <token>

Token-based authentication using access tokens.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X PUT "https://v2.api.piktid.com/webhooks" \  -H "Content-Type: application/json" \  -d '{    "url": "http://example.com"  }'
{
  "id": 0,
  "url": "string",
  "secret": null,
  "is_active": true,
  "created_at": "string",
  "updated_at": "string",
  "last_response_status": null,
  "last_response_at": null
}
{
  "error": "Invalid request",
  "detail": [
    {
      "field": null,
      "message": "string",
      "position": "query"
    }
  ]
}
Empty