Get Hook | Scout | Documentation

1 import requests 2 3 url = "https://api-prod.scoutos.com/webhooks/hook_id/details" 4 5 headers = {"Authorization": "Bearer <token>"} 6 7 response = requests.get(url, headers=headers) 8 9 print(response.json())

1 { 2 "id": "string", 3 "organization_id": "string", 4 "name": "string", 5 "description": "string", 6 "target_id": "string", 7 "status": "active", 8 "response_mode": "async", 9 "allowed_methods": [ 10 "string" 11 ], 12 "max_payload_size": 1048576, 13 "secret": "string", 14 "url": "string", 15 "created_at": "2024-01-15T09:30:00Z", 16 "updated_at": "2024-01-15T09:30:00Z", 17 "created_by": {}, 18 "target_type": "workflow", 19 "target_config": { 20 "field_mappings": [ 21 { 22 "source_path": "string", 23 "target_field_id": "string", 24 "transform": "string" 25 } 26 ], 27 "default_field_id": "string", 28 "run_mode": "async", 29 "timeout_seconds": 30, 30 "verify_token": "string" 31 } 32 }

Get a hook by its ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

hook_idstringRequired

Response

Successful Response

WorkflowHookobject

PulseHookobject

AgentHookobject

AutomationHookobject

Authentication

Path parameters

Response

Errors