WebhookEndpoint APIs

Last update: Mar 15, 2024.

WebhookEndpoint APIs are the means by which your integration communicates with the Acrobat Sign service about webhookEndpoints to support OAuth2.0 in the Webhooks. Use the various API endpoints to create, delete, modify, and retrieve information about your webhookEndpoints. The account level setting, WEBHOOK_OAUTH20_ROLLOUT, needs to be set to use this feature.

Acrobat Sign APIs include the endpoints described below.

POST /webhookEndpoints

POST Request object

{`{
  "name": "",
  "description": "",
  "webhookEndpointUrl": "",
  "applicationIds": [ "" ],
  "oAuth20": {
    "authorizationServerUrl": "",
    "clientId": "",
    "clientSecret": "",
    "scope": "",
    "customHeaders": [
      {
        "headerName": "header1",
        "headerValue": "value1"
      }
    ]
  }
}`}

POST Response object

WebhookEndpointResponse{`{
  "id": ""
}` }

Error codes

Be aware that APIs may return new errors or evolve existing error codes. Clients should be ready to handle errors they may not fully comprehend using default procedures.

Error codes

POST /webhookEndpoints is used to create a webhookEndpoint that supports OAuth2.0 for webhooks in Acrobat Sign.

• Only an Account Admin can create a webhookEndpoint.
• The application creating the webhookEndpoint must have webhook_write scope.
• Only one webhookEdnpoint can be created for an application. But, multiple webhooks can be associated with a webhookEndpoint (see the changes to POST /webhooks).
• Group Admin and Account Admin can read the webhookEndpoints that belong to the same account.

The HTTP Location header field is returned in the response to provide information about the location of a newly created resource.

Usage of access token

Adobe Acrobat Sign uses the credentials provided in the OAuth2.0 to call the authorization server URL to get the access_token before a webhook notification. A standard response from the authorization server contains the following fields:

• access_token: It is the only mandatory field.
• refresh_token: It is an optional field.
• token_type: Bearer token type is supported.
• expires_in: It is measured in seconds.

{
  "access_token":"HereIsYourSuperSecretAccessToken",
  "refresh_token":"HereIsYourSuperSecretRefreshToken",
  "token_type":"Bearer",
  "expires_in":3600
}

GET /webhookEndpoints

GET List Response object

{`{
  "page": {
    "nextCursor": ""
  },
  "webhookEndpointList": [
    {
      "name": "webhookEndpoint_12_01_2023_1",
      "description": "webhookEndpoint_12_01_2023_1",
      "webhookEndpointId": "9c5ce683-011a-4663-b275-4d6c14193e8c",
      "webhookEndpointUrl": "https://.your.domain.com/queryParameter?qp_1=",
      "applicationIds": [
        "CBJCHBCAABAAC7LB161JEvq9PcSXTbplkpw3XpvAvnGr"
      ],
      "oAuth20": {
        "scope": "openid",
        "authorizationServerUrl": "https://your.authorization.server/oAuth20",
        "clientId": "yourClinetId",
        "customHeaders": [
          {}
        ]
      }
    }
  ]
}`}

Error codes

Be aware that APIs may return new errors or evolve existing error codes. Clients should be ready to handle errors they may not fully comprehend using default procedures.

Error codes

GET /webhookEndpoints/{webhookEndpointId}

GET List by ID Response object

{`{
    "name": "webhookEndpoint_12_01_2023_1",
    "description": "webhookEndpoint_12_01_2023_1",
    "webhookEndpointId": "9c5ce683-011a-4663-b275-4d6c14193e8c",
    "webhookEndpointUrl": "https://*.your.domain.com/queryParameter?qp_1=*",
    "applicationIds": [
        "CBJCHBCAABAAC7LB161JEvq9PcSXTbplkpw3XpvAvnGr"
    ],
    "oAuth20": {
        "scope": "openid",
        "authorizationServerUrl": "https://your.authorization.server/oAuth20",
        "clientId": "anyThing",
        "customHeaders": [
            {}
        ]
    }
}`} 

Error codes

Be aware that APIs may return new errors or evolve existing error codes. Clients should be ready to handle errors they may not fully comprehend using default procedures.

Error codes

PUT /webhookEndpoints/{webhookEndpointId}

PUT Request body

{`{
    "name": "",
    "description": "",
    "webhookEndpointUrl": "",
    "applicationIds": [ "" ],
    "oAuth20": {
      "authorizationServerUrl": "",
      "clientId": "",
      "clientSecret": "",
      "scope": "",
      "customHeaders": [
      {
        "headerName": "header1",
        "headerValue": "value1"
      }
      ]
    }
}`} 

Error codes

Be aware that APIs may return new errors or evolve existing error codes. Clients should be ready to handle errors they may not fully comprehend using default procedures.

Error codes

DELETE /webhookEndpoints/{webhookEndpointId}

Error codes

Be aware that APIs may return new errors or evolve existing error codes. Clients should be ready to handle errors they may not fully comprehend using default procedures.

Error codes

Standard API request headers

Every API request will have the following standard headers. If Any API in the list above does not have one or more of the following headers, the API will explicitly document this fact.

Error codes

Standard API request error codes

Any API request may return any of these standard error codes:

Error codes

© Copyright 2022, Adobe Inc.. Last update: Mar 15, 2024.