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

Create webhook

POST

https://api.signater.com/v1/core/webhooks

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

Creates a webhook receiver: the address deliveries go to, the HTTP method, the events and how the deliveries authenticate. The receiver starts active. Its origin comes from the credential of the call: an API token records the API, an MCP connection the MCP and an automation platform connection that platform. The envelope.anchored event needs the Enterprise plan and is not available in sandbox. Administrators only.

Request

Authorization

Add parameter in header

x-api-token

Example:

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

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 '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

🟢201Created

application/json

Webhook created successfully; the body is the receiver as GET /v1/core/webhooks/{webhookId} answers it

Bodyapplication/json

Example

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "createdAtUtc": "2019-08-24T14:15:22.123Z",
    "createdById": "e13e432a-5323-4484-a91d-b5969bc564d9",
    "createdByName": "string",
    "createdByAvatar": "string",
    "updatedAtUtc": "2019-08-24T14:15:22.123Z",
    "lastUpdateById": "1b03e667-1c9e-4cf3-bc75-e4bd9235c8eb",
    "updatedByName": "string",
    "updatedByAvatar": "string",
    "name": "string",
    "description": "string",
    "url": "string",
    "httpMethod": "Get",
    "authMethod": "HookdeckSignature",
    "authMethodBasicAuthConfig": {
        "username": "string",
        "hasPassword": true
    },
    "authMethodApiKeyConfig": {
        "key": "string",
        "to": "Header",
        "hasApiKey": true
    },
    "authMethodBearerTokenConfig": {
        "hasToken": true
    },
    "authMethodOAuth2ClientCredentialsConfig": {
        "clientId": "string",
        "scope": "string",
        "authServer": "string",
        "authenticationType": "Basic",
        "hasClientSecret": true
    },
    "authMethodOAuth2AuthorizationCodeConfig": {
        "clientId": "string",
        "scope": "string",
        "authServer": "string",
        "hasClientSecret": true,
        "hasRefreshToken": true
    },
    "authMethodCustomSignatureConfig": {
        "key": "string",
        "hasSigningSecret": true
    },
    "authMethodAwsSignatureConfig": {
        "accessKeyId": "string",
        "hasSecretAccessKey": true
    },
    "eventTypes": [
        "string"
    ],
    "systemCreator": "Web"
}

🟠400Bad Request

🟠401Unauthorized

🟠402

🟠403Forbidden

🟠429

🟠451

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

Get webhook

Update webhook