Update webhook

PUT 
/config/webhook/:webhookId

This endpoint is used to update an existing webhook to trigger events to an external IT system.

Request

Path Parameters

webhookId stringrequired

application/json

Body

required

webhook object

id string

Webhook Id

orgId string

Organisation Id

payloadUrl stringrequired

Webhook payload Url

contentType stringrequired

Possible values: [application/json, application/x-www-form-urlencoded]

Webhook payload content type

subscribedEvents objectrequired

consentManagementWebhook string[]

Possible values: [data.update.initiated, data.update.cancelled, consent.allowed, consent.disallowed, consent.auto_expiry, org.unsubscribed, data.delete.initiated, data.download.initiated, data.delete.cancelled, data.download.cancelled, org.subscribed]

digitalWalletWebhook string[]

Possible values: [digitalwallet.connection.init, digitalwallet.connection.invitation, digitalwallet.connection.request, digitalwallet.connection.response, digitalwallet.connection.active, digitalwallet.connection.error, digitalwallet.connection.inactive, digitalwallet.connection.delete, digitalwallet.credential.proposal_sent, digitalwallet.credential.proposal_received, digitalwallet.credential.offer_sent, digitalwallet.credential.offer_received, digitalwallet.credential.request_sent, digitalwallet.credential.request_received, digitalwallet.credential.credential_issued, digitalwallet.credential.credential_received, digitalwallet.credential.credential_acked, digitalwallet.presentation.proposal_sent, digitalwallet.presentation.proposal_received, digitalwallet.presentation.request_sent, digitalwallet.presentation.request_received, digitalwallet.presentation.presentation_sent, digitalwallet.presentation.presentation_received, digitalwallet.presentation.verified, digitalwallet.presentation.presentation_acked]

disabled booleanrequired

Is webhook disabled or not

secretKey stringrequired

Secret key for checking authenticity of the source

skipSslVerification booleanrequired

Skip SSL verification for webhook Url

timestamp stringrequired

Creation timestamp

Responses

200

OK

Response Headers

application/json

Schema

Schema

webhook object

id string

Webhook Id

orgId string

Organisation Id

payloadUrl stringrequired

Webhook payload Url

contentType stringrequired

Possible values: [application/json, application/x-www-form-urlencoded]

Webhook payload content type

subscribedEvents objectrequired

consentManagementWebhook string[]

Possible values: [data.update.initiated, data.update.cancelled, consent.allowed, consent.disallowed, consent.auto_expiry, org.unsubscribed, data.delete.initiated, data.download.initiated, data.delete.cancelled, data.download.cancelled, org.subscribed]

digitalWalletWebhook string[]

Possible values: [digitalwallet.connection.init, digitalwallet.connection.invitation, digitalwallet.connection.request, digitalwallet.connection.response, digitalwallet.connection.active, digitalwallet.connection.error, digitalwallet.connection.inactive, digitalwallet.connection.delete, digitalwallet.credential.proposal_sent, digitalwallet.credential.proposal_received, digitalwallet.credential.offer_sent, digitalwallet.credential.offer_received, digitalwallet.credential.request_sent, digitalwallet.credential.request_received, digitalwallet.credential.credential_issued, digitalwallet.credential.credential_received, digitalwallet.credential.credential_acked, digitalwallet.presentation.proposal_sent, digitalwallet.presentation.proposal_received, digitalwallet.presentation.request_sent, digitalwallet.presentation.request_received, digitalwallet.presentation.presentation_sent, digitalwallet.presentation.presentation_received, digitalwallet.presentation.verified, digitalwallet.presentation.presentation_acked]

disabled booleanrequired

Is webhook disabled or not

secretKey stringrequired

Secret key for checking authenticity of the source

skipSslVerification booleanrequired

Skip SSL verification for webhook Url

timestamp stringrequired

Creation timestamp

Example (from schema)

{
  "webhook": {
    "id": "string",
    "orgId": "string",
    "payloadUrl": "string",
    "contentType": "application/json",
    "subscribedEvents": {
      "consentManagementWebhook": [
        "data.update.initiated"
      ],
      "digitalWalletWebhook": [
        "digitalwallet.connection.init"
      ]
    },
    "disabled": true,
    "secretKey": "string",
    "skipSslVerification": true,
    "timestamp": "string"
  }
}

Loading...