executeWebHook

POST
1
/{orgId}/{itemId}/jobTemplates/{jobTemplateId}/automatedCreation/{automationId}/executeWebhook

Execute a webhook to create a new job.

Executes a webhook to create a new job. This requires the ArcGIS Workflow Manager Server Advanced role. The jobCreate privilege and access to the workflow item are required. If the primary credentials fail, use the fallback credentials. If the attachment is defined in the webhook, the input JSON is added to the job as an attachment in the folder defined. The default size limit of job attachment is 10MB. If the request was sent by a Feature Service webhook and Extract Changes is enabled, the action's output values are taken from the changesUrl value in the request body.

Starting at 11.2, the headerSecretKey is required to execute webhooks. Enter the key and value that was used in the headerSecret parameter when the webhook was created. If you are using the ArcGIS Webhook header security option, set the key to x-esriHook-Signature.

If you choose not to set the headerSecretKey, you must add allowUnsecureWebhooks: true to the WorkflowManager.conf file to continue using the webhook. If you have an existing webhook where the headerSecret is set, but isEnabled is set to false, you must update isEnabled to true.

Note: This functionality is not supported in ArcGIS Online.

Body parameters

Supported content types: application/json

NameTypeRequiredDescription

Any valid JSON object or empty

body

Any valid JSON object or empty

Path parameters

NameTypeRequired

jobTemplateId

string

automationId

string

orgId

string

itemId

string

Examples

Request

1
2
3
4
5
6
# You can also use wget
curl -X POST /{orgId}/{itemId}/jobTemplates/{jobTemplateId}/automatedCreation/{automationId}/executeWebhook \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}' \
  --data '{}'

Response

StatusMeaningDescriptionSchema

200

OK

success

CreateJobsResponse

404

Not Found

error

WorkflowExceptionDTO

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close