This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

Update webhook

PUT

https://api.signater.com/v1/core/webhooks/{webhookId}

Last modified:2026-11-08 03:50:45

Replaces the full state of a webhook receiver: name, description, address, method, events and authentication, credentials included. Events left out stop being delivered. It does not change whether the receiver is active. Answers 404 for a removed receiver or one of another account. Administrators only.

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Path Params

Body Params application/json

Example

{
    "name": "ERP integration",
    "description": "Sends signed envelopes to the ERP",
    "url": "https://erp.example.com/webhooks/signater",
    "httpMethod": "Post",
    "authMethod": "BearerToken",
    "authMethodBasicAuthConfig": null,
    "authMethodApiKeyConfig": null,
    "authMethodBearerTokenConfig": {
        "token": "erp-token"
    },
    "authMethodOAuth2ClientCredentialsConfig": null,
    "authMethodOAuth2AuthorizationCodeConfig": null,
    "authMethodCustomSignatureConfig": null,
    "authMethodAwsSignatureConfig": null,
    "eventTypes": [
        "EnvelopeSigned",
        "EnvelopeRejectedBySigner"
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.signater.com/v1/core/webhooks/' \
--header 'x-api-token: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "ERP integration",
    "description": "Sends signed envelopes to the ERP",
    "url": "https://erp.example.com/webhooks/signater",
    "httpMethod": "Post",
    "authMethod": "BearerToken",
    "authMethodBasicAuthConfig": null,
    "authMethodApiKeyConfig": null,
    "authMethodBearerTokenConfig": {
        "token": "erp-token"
    },
    "authMethodOAuth2ClientCredentialsConfig": null,
    "authMethodOAuth2AuthorizationCodeConfig": null,
    "authMethodCustomSignatureConfig": null,
    "authMethodAwsSignatureConfig": null,
    "eventTypes": [
        "EnvelopeSigned",
        "EnvelopeRejectedBySigner"
    ]
}'

Responses

🟢204No Content

Webhook updated successfully

This response does not have a body.

🟠400Bad Request

🟠401Unauthorized

🟠402

🟠403Forbidden

🟠404Record Not Found

🟠429

Modified at 2026-11-08 03:50:45

Create webhook

Remove webhook