Skip to content
rigid.fi

Update a webhook endpoint

PATCH/v1/webhook-endpoints/{id}

Requires an API client bearer token.

Updates a webhook endpoint (url, event_types, active). Requires an Idempotency-Key header.

Parameters

Path parameters

NameRequiredDescription
idrequired

Header parameters

NameRequiredDescription
Idempotency-Keyrequired

Client-chosen. An identical retry with the same key returns the stored response; reusing the key with a different payload returns 409.

Request body

urlstring (uri)
event_typesarray of one of
+ show properties

One of

Option 1

{
  "type": "string",
  "enum": [
    "*"
  ]
}

Option 2

{
  "type": "string",
  "enum": [
    "programme.created",
    "programme.updated",
    "card_product.created",
    "cardholder.created",
    "cardholder.updated",
    "kyc.check.started",
    "kyc.check.completed",
    "kyc.check.expired",
    "card.created",
    "card.transition",
    "authorization.decided",
    "transaction.cleared",
    "clearing.exception.raised",
    "settlement.position.created",
    "webhook.delivery.failed",
    "simulator.program.started",
    "simulator.program.step.completed",
    "simulator.program.completed",
    "simulator.program.failed",
    "ledger.entry.posted",
    "ledger.funds.issued",
    "ledger.hold.placed",
    "ledger.hold.released",
    "ledger.hold.captured",
    "screening.snapshot.activated",
    "screening.hit.raised"
  ]
}
activeboolean

Example

curl -X PATCH https://api.rigid.fi/v1/webhook-endpoints/{id} \
  -H "Authorization: Bearer $RIGID_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "url": "uri",
  "event_types": [
    "*"
  ],
  "active": true
}'

Responses

200

Updated endpoint.

idstringrequired
urlstringrequired
event_typesarray of stringrequired
activebooleanrequired
created_atstringrequired
programme_idstring (uuid) | nullrequired
400

Validation error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
401

Authentication required

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
403

Forbidden

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
404

Webhook endpoint not found

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
409

Idempotency-Key reused with a different payload

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring