Update signing key for a hook

PATCH /api/hooks/{id}/signing-key

OAuth2

Update the signing key for the specified hook.

Path parameters

id string Required

The unique identifier of the hook.

Responses

200 application/json

The signing key for the hook was updated successfully.
Hide response attributes Show response attributes object
- tenantId string Required
  
  Maximum length is 21.
- id string Required
  
  Minimum length is 1, maximum length is 21.
- name string Required
  
  Maximum length is 256.
- event string | null Required
  
  Values are PostRegister, PostSignIn, PostResetPassword, User.Created, User.Deleted, User.Data.Updated, User.SuspensionStatus.Updated, Role.Created, Role.Deleted, Role.Data.Updated, Role.Scopes.Updated, Scope.Created, Scope.Deleted, Scope.Data.Updated, Organization.Created, Organization.Deleted, Organization.Data.Updated, Organization.Membership.Updated, OrganizationRole.Created, OrganizationRole.Deleted, OrganizationRole.Data.Updated, OrganizationRole.Scopes.Updated, OrganizationScope.Created, OrganizationScope.Deleted, or OrganizationScope.Data.Updated.
- events array[string] Required
  
  Values are PostRegister, PostSignIn, PostResetPassword, User.Created, User.Deleted, User.Data.Updated, User.SuspensionStatus.Updated, Role.Created, Role.Deleted, Role.Data.Updated, Role.Scopes.Updated, Scope.Created, Scope.Deleted, Scope.Data.Updated, Organization.Created, Organization.Deleted, Organization.Data.Updated, Organization.Membership.Updated, OrganizationRole.Created, OrganizationRole.Deleted, OrganizationRole.Data.Updated, OrganizationRole.Scopes.Updated, OrganizationScope.Created, OrganizationScope.Deleted, or OrganizationScope.Data.Updated.
- config object Required
  
  Additional properties are allowed.
  
  Hide config attributes Show config attributes object
  
  url string Required
  
  headers object
  
  Hide headers attribute Show headers attribute object
  
  * string Additional properties
  
  retries number
- signingKey string Required
  
  Maximum length is 64.
- enabled boolean Required
- createdAt number Required
400

Bad Request
401

Unauthorized
403

Forbidden
404

Not Found

PATCH /api/hooks/{id}/signing-key

curl \
 -X PATCH https://[tenant_id].logto.app/api/hooks/{id}/signing-key \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "tenantId": "string",
  "id": "string",
  "name": "string",
  "event": "PostRegister",
  "events": [
    "PostRegister"
  ],
  "config": {
    "url": "string",
    "headers": {
      "additionalProperty1": "string",
      "additionalProperty2": "string"
    },
    "retries": 42.0
  },
  "signingKey": "string",
  "enabled": true,
  "createdAt": 42.0
}