Sign in
Events v2.Webhook
REGION.US

Update Webhook Endpoint

Updates a Webhook Endpoint.

patch/events/v2/webhook-endpoints/{webhookEndpoint.id}

Path parameters

webhookEndpoint.idstring required

A Tink unique identifier for the webhook endpoint.

Request body

Example request

{
  "webhookEndpoint": {
    "description": "Alice's webhook",
    "disabled": false,
    "enabledEvents": [
      "refresh:finished"
    ],
    "url": "https://endpoint.example.com/"
  }
}

Response

A successful response.

createdAtstring date-time required

Time at which the webhook was stored specified as a ISO-8601 date and time string in UTC (e.g. 2020-12-15T09:25:12Z) or with time zone offset (e.g. 2020-12-15T10:25:12+01:00).

descriptionstring

An optional description of what the webhook is used for.

disabledboolean required

Marks whether the webhook is disabled. Defaults to false.

enabledEventsstring[] required

The list of events to enable for this endpoint.

idstring required

A Tink unique identifier for the webhook endpoint.

secretstring
updatedAtstring date-time required

Time at which the webhook was updated specified as a ISO-8601 date and time string in UTC (e.g. 2020-12-15T09:25:12Z) or with time zone offset (e.g. 2020-12-15T10:25:12+01:00).

urlstring required

Example response

{
  "createdAt": "2022-11-30T15:27:59Z",
  "description": "Alice's webhook",
  "disabled": false,
  "enabledEvents": [
    "refresh:finished"
  ],
  "id": "d8f37f7d19c240abb4ef5d5dbebae4ef",
  "updatedAt": "2022-11-30T15:27:59Z",
  "url": "https://endpoint.example.com/"
}

Changes